تصور کنید که در یک شرکت تعداد زیادی از برنامه نویس ها مشغول برنامه نویسی بر روی ماژول ها میباشند . حالا اگر هر یک از این برنامه نویس ها شیوه های برنامه نویسی خود را اختراع کنند چه پیش می آید ؟!

مدیریت سورس کد امکان ناپذیر میشود و نگهداری از ان کد در اینده بسیار مشکل خواهد شد .

بنابراین برنامه نویسی استاندارد بسیار ضروری است .


در اینجا چند دلیل برای استاندارد کد زدن آورده شده است :

  • همکار برنامه نویس شما باید کدهای شما را بفهمد ، کدزنی استاندارد مثل یک طرح برای تیم شماست تا کدها را راحت تر درک کنند .
  • سادگی و شفافیت کد باعث میشود تا از اشتباهات رایج جلوگیری کنید 
  • اگر خواستید روزی کدهای خود را تغییر دهید ، اینکار برای شما اسان تر خواهد شد 

در ادامه مطلب بخوانید ...



چند دستورالعمل ساده وجود دارد که میتوانید در کدزدن خود از آنها پیروی کنید 

دندانه دار کردن و طول خطوط
از 4 space برای دندانه دار کردن استفاده کنید و از tab استفاده نکنید ، چرا که هر کامپیوتر تنظیمات جداگانه ای برای تب گذاری دارد 
توصیه میشود برای خوانایی کدها طول خطوط را تقریباً بین 75 تا 85 کاراکتر نگه دارید

ساختار های کنترل
ساختارهای کنترل شامل if , while , for , switch و ... می باشد .
برای تمیز دادن ساختار های کنترل از توابع باید بین ساختار کنترل و پرانتز باز " ) " باید یک اسپیس وجود داشته باشد 

برای مثال :
if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

یا میتوانید دستور switch را به صورت زیر بنویسید :
switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

فراخوانی توابع 
توابع باید بدون هیچ space ی بینِ نام تابع و پرانتزِ باز ، پرانتزِ باز و اولین پارامتر و آخرین پارامتر و پرانتز بسته وجود داشته باشد .
همچین بین هر پارامتر و علامت "," باید یک space وحود داشته باشد .
$var = foo($bar, $baz, $quux);

تعریف توابع
تعریف تابع از BSD / Allman style پیروی می کند .
function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

کامنت
کامنت گذاری به سبک /* */ و // خوب و مناسب هستند ، استفاده از کامنت گذاری # توصیه نمی شود .

تگ PHP
همیشه از تگ <?php ?> استفاده کنید و سعی کنید از short tag  ( <؟ ؟> ) کمترین استفاده کنید ، اینکار باعثِ افزایش قابل حمل بودن برنامه میشود .

نام متغیر ها
  • از حروف کوچک استفاده کنید 
  • از "_" برای جدا کردن کلمات استفاده کنید 
  • نام متغیر های global را با g شروع کنید .
  • نام متغیر های static را با s شروع کنید .

هم ترازی بلاک ها
بلاک ها {} باید کاملا هم تراز تنظیم شوند .

یک دستور در هر خط
در هر ط باید تنها یک دستور وجود داشته باشد مگر آنکه دستور ها بسیار به هم نزدیک باشند .

ممکن است نکات زیاد دیگری وجود داشته باشد که شما در حین کدزنی باید آنها را رعایت کنید 


منبع : https://www.tutorialspoint.com/php/php_coding_standard.htm
ترجمه : محمدباقر عباسی