چطور به کد های خود توضیحات اضافه کنیم
با سلام خدمت شما دوستان عزیز. در این آموزش قصد داریم نحوه اضافه کردن توضیحات به کدهای PHP، CSS، HTML و جاوا اسکریپت را توضیح دهیم.
وقتی شروع به طراحی سایت خود می کنید سعی کنید تا حد امکان کد ها را بصورت ساده و قابل فهم بنویسید. از پیچیده کردن کد ها بپرهیزید چرا که اگر در آینده نیاز به تغییر قسمتی از کد داشتید بتوانید به سادگی آن را اعمال کنید. به همین منظور بهتر است برای هر قطعه کدی که می نویسید یک بخش راهنما یا توضیح اضافه کنید تا پس از گذشت زمان علت استفاده از آن قطعه کد و یا کار آن را فراموش نکنید و با خواندن توضیح اطلاعات مورد نیاز در مورد آن قطعه کد را بدست آورید. این توضیح اضافی را کامنت می نامند.
خط هایی از برنامه که بصورت کامنت (comment) نوشته می شوند، اجرا نمی شوند و از دید کاربر مخفی می مانند. کامنت ها برای عیب یابی خطاهای برنامه در آینده، مخفی کردن قسمتی از کد بجای حذف آن از برنامه، قرار دادن اطلاعاتی در مورد عملکرد یک بخش از برنامه و ... می تواند بکار رود. در صورتیکه که سورس پروژه را به شخص دیگری هم بدهید می تواند با خواندن کامنت ها از سورس برنامه استفاده بهتری کند. سعی کنید کامنت ها را بصورت ساده و قابل فهم بنویسید. مختصر و مفید و در عین حال کامل.
در ادامه روش افزودن کامنت به برنامه را شرح خواهیم داد.
کامنت در HTML
برای اضافه کردن کامنت به کدهای HTML از علامت زیر استفاده می کنیم:
<!-- توضیحات خود را اینجا وارد کنید -->
به مثال زیر توجه کنید:
<html> <head> <title>chasboon.ir</title> </head> <body> <!-- کامنت یک خطی --> <p>A paragraph in your site</p> <!-- کامنت چند خطی در HTML <h1>Commented Title</h1> <p>A paragraph that is commented out.</p> --> </body> </html>
کامنت در CSS، JavaScript و PHP
برای اضافه کردن توضیح به کدهای خود در زبان PHP و یا جاوا اسکریپت و یا حتی CSS بصورت زیر عمل کنید:
در صورتیکه بخواهید کامنت یک خطی به کد خود اضافه کنید:
// توضیحات خود را اینجا بنویسید
همچنین برای افزودن توضیحات چند خطی به برنامه می توانید از روش زیر استفاده کنید:
/* <code to be commented out> <Other code to be commented out> <Some more code to be commented out> */
مثال:
<html> <body> <?php // این یک کامنت ۱ خطی می باشد echo '<p>HTML code echoed by PHP.</p>'; /* دستورات زیر بصورت کامنت درج شده و اجرا نمی شود echo '<h1>An HTML Title from PHP</h1>'; echo '<p>HTML code echoed by PHP.</p>'; */ ?> </body> </html>
امیدوارم این آموزش برایتان مفید باشد. چسبون- مرجع برنامه نویسی و طراحی وب