بازگشت به دوره

توضیحات در برنامه نویسی (Comments)

در فصل قبل جاوا اسکریپت را معرفی کردیم و مقدمات برنامه‌نویسی با جاوا اسکریپت را نیز آماده کردیم. حتی دستانمان را به نوشتن چند برنامه‌ی ساده با جاوا اسکریپت آلوده کردیم! در این فصل کمی بیشتر وارد جزئیات جاوا اسکریپت می‌شویم و با اصول برنامه‌نویسی در جاوا اسکریپت آشنا می‌شویم. البته در این فصل هیچ برنامه‌ای نخواهیم نوشت و فقط با مبانی برنامه‌نویسی آشنا می‌شویم تا در فصول بعدی از مباحث مطرح شده در این فصل برای نوشتن برنامه‌ها استفاده کنیم.

آنچه در این فصل می‌آموزید :  

توضیحات

اولین قدمی که در راه تبدیل شدن به یک برنامه‌نویس حرفه‌ای جاوا اسکریپت برمی‌داریم، آشنایی با نحوه‌ی نوشتن توضیحات (Comments) در کدهای جاوا اسکریپت است. شاید این نقطه برای شروع کمی عجیب به نظر برسد. چرا که توضیحات در برنامه‌نویسی، بخش‌هایی از کد هستند که توسط مفسر (یا کامپایلر) نادیده گرفته می‌شوند. یعنی توضیحات در عمل هیچ کاری انجام نمی‌دهند. با این وجود، توضیحات اهمیت خیلی بالایی دارند و یکی از نشانه‌های یک برنامه‌نویس حرفه‌ای، نوشتن توضیحات مناسب در برنامه است.

توضیحات به افراد کمک می‌کنند تا بهتر بتوانند کدهای شما را مطالعه کرده و نحوه‌ی عملکرد آن را متوجه شوند. توجه کنید که خود شما هم یکی از همین افراد هستید. اگر توضیحات را به شکل مناسبی در کدهای خود به کار برده باشید، در آینده بسیار از خودتان سپاسگذار خواهید بود. زمانی که پس از چند هفته دوباره به کدهایی که نوشته‌اید سر می‌زنید. لازم نیست در نوشتن توضیحات زیاده روی کنید و برای هر خط از کد، یک مقاله به عنوان توضیحات بنویسید. فقط کافی است برای هر قطعه‌ای از کد، هدف آن و نحوه‌ی عملکرد آن را به صورت خلاصه در یک یا دو خط توضیح دهید. (البته در مواردی نوشتن توضیحات طولانی‌تر هم مورد نیاز خواهد بود. اما چنین مواردی به ندرت بروز می‌کنند)

در جاوا اسکریپت دو روش برای نوشتن توضیحات وجود دارد : 

// this is a short comment


/* This is a longer comment
anything here will be ignored
This is a useful place to put notes
*/

سعی کنید نوشتن توضیحات در کدها را به یک عادت برای خود تبدیل کنید و مطمئن باشید که از این کار پشیمان نخواهید شد. حتی امروزه ابزارهایی به وجود آمده‌اند که می‌توانند با دریافت کدهای شما، از روی توضیحات داخل کدها، یک راهنمای کامل برای برنامه‌ی شما تولید کنند. البته این ابزارها به شرطی صحیح کار می‌کنند که توضیحات را به شکل مناسبی به کار برده باشید. از این دست ابزارها می‌توان به JSDoc Toolkit، Docco و YUIDoc اشاره کرد. یک نمونه‌ی بسیار مشهور از این نوع راهنماها، راهنمای Wordpress است که کاملاً به صورت خودکار و از روی توضیحات داخل کدها به وجود آمده است.