کدنویسی استاندارد در php

کدنویسی استاندارد با پی اچ پی

آموزش کدنویسی استاندارد در php

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

 

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

  • برنامه نویسان همکاری شما متوجه باشند که شما چه چیزی نوشته اید ، کدنویسی استاندارد مثل یک رمزگشا برای تمام اعضای یک گروه است که متوجه شوند کدهایی که دیگر اعضا نوشته اند چیست و چطور کار میکند 
  • سادگی و تمیزی کدهایی که بصورت استاندارد نوشته میشود باعث میشود که کمتر خطاهای رایج برای شما رخ بدهد 
  • اگر در آینده در بخشی از کدهای خود تجدید نظر کردید و خواستید اصلاحی را انجام دهید ، بهتر درک میکنید که در گذشته چه کاری انجام دادید 
  • از نظر صنعتی ، استفاده از یک چیز منظم و استاندارد محصول نهائی با کیفیت تری تولید خواهد کرد 

در زیر دستورالعمل هایی وجود دارد که برای کدنویسی php میتوانید استفاده کنید : 

  • جهش به جلو و طول هر خط از کدها : 
    برای اینکه در هر خط کمی جلوتر بروید از tab استفاده نکنید بجای آن  از 4 فاصله یا space استفاده کنید چون کامیپوترهای مختلف برای tab تنظیمات متفاوتی دارند .
    پیشنهاد میشود طول هر خط کدنویسی بین 75 تا 85  کاراکتر باشد 
  • ساختار بخش های کنترلی : 
    این بخش شامل دستورالعملی برای استفاده if, for, while, switch میباشد . بین دستور کنترلی و پارانتزی که بعد از آن باز میشود یک عدد فاصله یا space قرار گیرد . که این کار باعث میشود صدا زدن دستور با صدا زدن یک تابع از همدگیر راحت تر تشخیص داده شوند . همیشه سعی کنید از آکولاد باز و بسته استفاده کنید هرچند اگر استفاده از آن اختیاری باشد . 

    مثال : 
    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;
    }
  • صدا زدن توابع : 
    در صدا زدن یک تابع  نباید بین نام تابع و پرانتز باز فاصله وجود داشته باشد همچنین داخل پرانتز اگر پارامتری وجود دارد بین پرانتز و اولین پارامتر هم فاصله نگذارید  . اگر تابع شما چند پارامتر میپذیرد بهتر است بعد از اسم هر پارامتر و ویرگول یک فاصله بدهید و نام پارامتر دوم بنویسید وبه همین ترتیب ادامه دهید . 
    مثال : 
    $var = foo($bar, $baz, $quux);​

     

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

     

  • کامنت گذاری یا Comments  بصورت استاندارد در زبان php
    استایل استفاده شده در زبان C بصورت /* */ و همچنین استایل استفاده شده در c++ بصورت // برای کامنت گذاری عالی هستند ولی کامنت گذاری به شیوه ی پرل بصورت # زیاد جالب نیست  .

  • تگ های php بصورت استاندارد :
    سعی کنید همیشه برای باز کردن و بستن تگ php از <?php ?> استفاده کنید چرا که نیاز به تنظیمات خاص نیست و همه جا میشود استفاده کرد سعی کنید از <? ?> کمتر استفاده کنید چون نیاز به روشن کردن تنظیمات short open tag میباشد و ممکن است جایی این تنظیمات روشن نباشد و کدهای شما کار نکند .
  • نام گذاری متغیرها در php بصورت استاندارد 
    از قواعد زیر پیروی کنید : 
    • از حروف کوچک استفاده شود 
    • از کاراکتر _ بین کلمات استفاده کنید
    • برای متغیرهای سراسری باید حرف g  استفاده شود
    • برای نام ثابت های سراسری باید _  استفاده شود
    • متغیرهای استاتیک باید شامل  s باشند
  • توابع باید قابلیت استفاده مجدد داشته باشد پس از تعریف متغیرهای استاتیک خودداری کنید تا در جاهای دیگر نیز اگر نیاز باشد استفاده شود 
  • سعی کنید هر statement یا عمل در یک خط انجام بگیرد 
  • سعی کنید تا میتوانید کم کدنویسی کنید یعنی سعی کنید کاری که با خطوط زیاد انجام میشود را با خطوط کم انجام دهید اینطوری کدهای کمتر، قابل درک تر خواهید داشت 

 

در کل نکات فراوانی وجود دارد که هنگام کدنویسی php باید در نظر داشت و تمام این نکات تنها قصد دارند کدهای شما را زیباتر ، ساده تر و قابل نگهدارتر از قبل بکنند . رعایت این نکات به خود شما و تمام برنامه نویسان غیر از خودتان که شاید کدهای شما را ببینند قابل درک در آینده خواهد بود که باعث میشود توسعه ی یک پروژه قابل انجام و ساده تر باشد . 

بعد از یادگیری کامل زبان برنامه نویسی php شما میتوانید به بحث مهم آموزش php mvc بپردازید.

اتمام درس