توضیحات
افزودن توضیح (یا کامنت) به برنامه در بسیاری از زبان‌های برنامه‌نویسی بسیار سودمند است. تا کنون هر چه در برنامه‌های خود نوشته‌اید کد پایتون بوده است. هر چه برنامه بزرگ‌تر و پیچیده‌تر می‌شود، باید توضیحاتی به آن اضافه کنید تا رویکرد کلّی شما را برای حل مساله‌ای که در حال حل آن هستید، بیان کند. توضیح در برنامه‌های شما چنین کاربردی دارد و می‌توانید توضیحاتی به زبان انگلیسی به برنامه‌ی خود اضافه کنید.
چگونه یک توضیح بنویسیم؟
علامت هَش (#) در پایتون نمایان‌گر یک توضیح است. مفسّر پایتون هر آن‌چه را پس از این علامت بیاید نادیده می‌گیرد. برای مثال:
پایتون از خط اوّل می‌گذرد و دومی را اجرا می‌کند:
|
|
چه‌جور توضیحی باید به برنامه اضافه کنید؟
دلیل اصلی اضافه کردن توضیحات به برنامه این است که مقصود آن توضیح داده و بگویید که چگونه آن را به کار انداخته‌اید. هنگامی که شما در جریانِ انجام یک پروژه هستید می‌دانید که اجزای مختلف چگونه با هم جفت شده‌اند. امّا هنگامی که پس از گذشت مدت زمانی به پروژه برمی‌گردید به احتمال زیاد برخی از جزئیات را فراموش کرده‌اید. هرچند همیشه می‌توانید کد خود را بررسی کنید و بفهمید که قسمت‌های مختلف آن چگونه کار می‌کرده‌اند، امّا با نوشتن توضیحات مناسب و خلاصه کردن رویکرد کلّی خود به زبان ساده، در زمان صرفه‌جویی می‌کنید.
اگر می‌خواهید به برنامه‌نویسی حرفه‌ای تبدیل شوید و یا با برنامه‌نویسان دیگر همکاری کنید باید توضیحات معنادار بنویسید. امروزه بیشتر نرم‌افزارها را یا گروهی از برنامه‌نویسان در یک شرکت یا گروهی از مردم در قالب یک پروژه‌ی متن‌باز به صورت مشارکتی می‌نویسند. برنامه‌نویسان باتجربه انتظار دیدن توضیحات در کد دارند پس بهتر است از همین الان نوشتن توضیحات گویا در برنامه‌های خود را آغاز کنید. نوشتن توضیحات واضح و شفّاف در کد یکی از سودمندترین عادت‌هایی است که به عنوان یک برنامه‌نویس جدید می‌توانید پیدا کنید.
پیش از تصمیم‌گیری برای نوشتن یک توضیح به این فکر کنید که آیا برای رسیدن به جواب رویکردهای مختلفی را در نظر گرفته‌اید یا نه. اگر این چنین است توضیحی درباره‌ی راه‌حل خود بنویسید. این که بعداً چند توضیح اضافی را پاک کنید بسیار ساده‌تر از اضافه کردن توضیح به کدی است که به خوبی شرح داده نشده است. از الان به بعد از توضیحات در مثال‌ها استفاده خواهد شد تا بخش‌های مختلف کد توضیح داده شود.
خودآزمایی
اضافه کردن توضیح
از بین برنامه‌هایی که نوشته‌اید دو تا را انتخاب کنید و به هر کدام حداقل یک توضیح اضافه کنید. اگر به دلیل سادگی برنامه‌ها توضیحی برای افزودن نمی‌یابید صرفاً اسم و تاریخ نوشتن کد را بالای برنامه اضافه کنید. سپس یک جمله در مورد هدف برنامه اضافه کنید.