گرچه نکات از یک کتاب قدیمی گرفته شدهاند اما به شدت کاربردی و به دردبخور هستند.
- شفاف بنویسید، زرنگ بازی درنیاورید، شفافیت را فدای کارایی نکنید.
- منظورتان را بگویید، ساده و سرراست.
- از متغیرهای موقت دوری کنید.
- به کمک پرانتز، جلوی ابهام را بگیرید.
- از توابع کتابخانه استفاده کنید.
- عبارات تکراری را با فراخوانی یک تابع عمومی جایگزین کنید.
- نام متغیرها را طوری انتخاب کنید که باعث اشتباه نشود.
- اگر فهم یک عبارت منطقی سخت است، تغییرش دهید.
- از روشی برای ارائه داده استفاده کنید که برنامه را ساده کند.
- کد بد را وصله پینه نکنید، دوباره بنویسیدش.
- برنامه بزرگ را در تکههای کوچک بنویسید و تست کنید.
- ورودی را هم برای صحت و هم برای معقول بودن بررسی کنید.
- ورودی بد را تشخیص دهید و در صورت امکان اصلاحش کنید.
- مطمئن شوید که ورودی محدودیتها را نقض نکند.
- پایان ورودی را با علامت مشخص کنید نه با تعداد.
- فراهم کردن ورودی باید آسان و خروجی نیز واضح باشد.
- مطمئن شوید همه متغیرها قبل از استفاده مقداردهی اولیه شدهاند.
- مراقب خطاهای off-by-one باشید. [خطایی است که در حلقههای تکرار رخ میدهد، مثلا استفاده اشتباه از شرط «کوچکتر یا مساوی» به جای شرط «کوچکتر».]
- برنامه را برای مقادیر مرزی تست کنید.
- بعضی از پاسخها را به صورت دستی بررسی کنید.
- ۱۰ تا ۰.۱ به ندرت ۱ میشود.
- برای بررسی برابری از اعداد با ممیز شناور به تنهایی استفاده نکنید.
- قبل از این که سریعترش کنید درستش کنید.
- قبل از این که سریعترش کنید از خطا مصونش کنید.
- قبل از این که سریعترش کنید واضحش کنید.
- برای سریعتر کردن برنامه، الگوریتم را تغییر دهید نه فقط جزئیات کوچکی را در کد.
- برای دیدن سرعت برنامه آن را به صورت واقعی تست کنید.
- مراقب باشید که کد و کامنت متفاوت نباشند.
- از نامی برای متغیر استفاده کنید که معنی داشته باشد.
- کد را مرتب کنید تا به خواننده در فهم آن کمک نمایید.
- کد را در کامنت تکرار نکنید – کامنتها باید معنیدار باشند.
- ساختار داده را مستندسازی کنید.
- از کامنت صرف نظر نکنید.
- برای کد بد کامنت ننویسید – کد را بازنویسی کنید.
از: The Elements of Programming Style, Brian Kernighan and P. J. Plauger,McGraw-Hill Book Company, New York, 1974.
منبع: Bucknell University
دیدگاهتان را بنویسید