نوشتن و نگهداری کد لازم است زیرا شما می خواهید آن را به راحتی برای مردم قابل درک کنید. بنابراین در اینجا برخی از نکات من در مورد چگونگی نوشتن کد بهتر و نگهداری آن آورده شده است.
1. از کد جهانی خودداری کنید
- متغیرهای جهانی و حلقه ها یک خرابکاری هستند و وقتی برنامه شما به میلیون ها خط کد رشد کند ، مشکل ساز می شوند (اکثر آنها !!!).
- قبل از اینکه فضای نام جهانی را با متغیرها ، توابع ، حلقه ها و غیره آلوده کنید ، خوب فکر کنید.
2. از ساختارهای معنی دار استفاده کنید
- ساختار برنامه شما بسیار مهم است ، از ساختارهای پیچیده استفاده نکنید ، همیشه به سادگی بچسبید.
- همیشه چهار قسمت از هر برنامه معمولی را از یکدیگر جدا کنید – HTML ، الگوها / پوسته های CSS ، جاوا اسکریپت ، کد PHP.
3. از نام های معنی دار استفاده کنید
- هرگز از نام هایی مانند این استفاده نکنید
$k
،
%n
، و
$test
برای متغیرهای شما.
- کد خوب باید در ترمینال از نام متغیرها ، نام تابع / روش و نام کلاس معنی دار باشد.
- چند نمونه خوب از نام های معنی دار:
$request
،
$dbResult
و
$tempFile
(بسته به دستورالعمل های سبک برنامه نویسی شما ممکن است از زیر خط ، شتر یا مورد پاسکال استفاده شود)
4- نظرات مفیدی بنویسید
- برای خطوط مبهم نظرات معنی دار و تک خطی بنویسید.
- پارامترهای کامل و توضیحات عملکردها را برای توابع و روش ها بنویسید. برای بلوک های منطقی روی حیله و تزویر ، توصیف کنید …