1. مهمان گرامی، جهت ارسال پست، دانلود و سایر امکانات ویژه کاربران عضو، ثبت نام کنید.
    بستن اطلاعیه

قرار دادن توضیحات comments در اسکریپت های PHP

شروع موضوع توسط Amon Amarth ‏18/4/13 در انجمن PHP

  1. کاربر ارشد

    تاریخ عضویت:
    ‏7/6/12
    ارسال ها:
    12,082
    تشکر شده:
    28,151
    امتیاز دستاورد:
    113
    جنسیت:
    مرد
    قرار دادن توضیحات comments در اسکریپت های PHP



    گاهی اوقات می خواهید توضیحاتی را در صفحه قرار دهید ، تا در مراجعات بعدی راهنمای شما باشند . یا اینکه اگر کسی غیر از خودتان سورس کد صفحه را مطالعه می کند ، بتواند دریابد هر بخش صفحه چیست و برای چه منظور استفاده می شود . توضیحات را می توانید در هر جای صفحه که بخواهید قرار دهید .
    به این توضیحات در طراحی وب comments می گویند . توضیحات توسط مرور گرها نمایش داده نشده و از دید کاربر مخفی هستند و فقط در سورس کد صفحه قابل مشاهده می باشند .
    چنانچه توضیح در حد یک خط باشد ، با قرار دادن کد // در ابتدا خط ، توضیح خود را بعد از آن بنویسید .
    ولی چنانچه حجم توضیح بیش از یک خط باشد ، باید علامت */ را در ابتدای توضیح و علامت /* را در انتهای آن قرار دهید . از این روش برای توضیحات چند خطی استفاده می شود .
    در جدول زیر روش استفاده از هر دو مورد را به صورت عملی به شما نمایش داده ایم :
    [TABLE="class: ex"]
    [TR]
    [TD="class: prname"] Syntax
    توضیح یک خطی [/TD]
    [TD="class: prdes, align: left"] // متن توضیح [/TD]
    [/TR]
    [/TABLE]

    [TABLE="class: ex"]
    [TR]
    [TD="class: prname"] Syntax
    توضیح چند خطی [/TD]
    [TD="class: prdes, align: left"] /*
    خط 1 توضیح
    خط 2 توضیح
    خط 3 توضیح
    ...
    */ [/TD]
    [/TR]
    [/TABLE]
    مثال : درمثال زیر در یک صفحه PHP هم توضیح یک خطی و هم چند خطی قرار داده ایم . دقت کنید که این توضیحات در خروجی نمایش داده نمی شوند :
    [TABLE="class: ex"]
    [TR]
    [TD="class: header, colspan: 2"] Example
    [/TD]
    [/TR]
    [TR]
    [TD="class: body"] < html >
    < head >
    </head>
    <body>
    < p > This is a HTML Paragraph < /p >
    <?php
    // متن توضیح یک خطی
    echo "Hello World" ;
    /*
    خط 1 توضیح چند خطی
    خط 2 توضیح چند خطی
    ...
    */
    ?>
    </body>
    </html> [/TD]
    [TD="class: header"] کد [/TD]
    [/TR]
    [/TABLE]

    [HR][/HR]​
    منبع: developer1
     
    یک شخص از این تشکر کرد.