أساسيات برمجة المواقع بال بي اتش بي معايير كتابة كود PHP Coding Standards

 معايير كتابة كود

 PHP Coding Standards

معايير كتابة كود PHP Code Standards
معايير كتابة كود  PHP Coding Standards

معايير كتابة كود  PHP Coding Standards

كل شركة تتبع معيير خاصة فيها عند كتابة الأكود وذلك لان لديها الكثير من المبرمجين الذين يع عاملون في نفس المشروع او النماذج.
ولذلك نظرا لوجود الكثير من العاملين كان لابد اتباع معايير محددة بحيث عند قراءة  الكود يكون واضح ومفهوم لدى اي عامل في الشركة.هناك معايير خاصة في البي اتش بي وقد وضعها مبرمجوا اللغة لتكون واضحة ومفهومة لاي مبرمج وهناك معايير خاصة بالشركات وضعتها الشركات  للعاملين معها.

وهذه أسباب استخدام معايير كتابة الكود

  • يمكن للشركاء في المشروع فهم الكود فلا حاجة لاضاعة الوقت في كود انت كتبته لان معايير كتابة الكود عبارة عن نسخة كربونية لجميع أفراد المشروع.
  • السهولة والوضوح ولذلك يساعدك على حل الأخطا البرمجية الشائعة
  • في حال تركت مشروعك وقتا ثم عدت   ستجد نفسك من السهل فهمه مرة أخرة
  • معايير كتابة الأكود هي معايير صناعية تستخدم معايير محددة لمخرجات جودة أفضل.

دليل معايير كتابة كود بي اتش بي PHP

  • طول سطر الكود والمسافات.

يجب أن  لا يزيد طول سطر الكود عن 75 الى 85 حرفا كما ان المسافات لا تستخدم أكثر من أربع مرات متتالية ولا يستخدم Tab
لانها تختلف من جهاز الى أخر.

  • جمل التحكم أوالجمل الشرطية

وهذه يتضمن (if , Switch while,for,do while,until,foreach,break,continue,if else)
يجب أن لا توجد مسافة بين الكلمة المحجوزة المستخدمة في جمل التحكم وذلك لتميزها عن استدعاء  الدوال.
استخدام الحاصرتين {} حتى وان كان شرط واحد أو خيار وحيد.

مثال على معايير كتابة كود الجمل الشرطية PHP


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);

مثال على كود معيار تعريف دالة الدوال

function fooFunction($arg1, $arg2 = '')
{
    if (condition) {
        statement;
    }
    return $val;
}

  • التعليقات في البي اتش بي

يفضل استخدام التعليقات التي تستخدم في لغة السي وهو (/*  تعليقك هنا */) أو في لغة سي بلس بلس وهو (تعليقك هنا //).
لاينصح استخدام التعليقات المستخدمة في perl او shell وهو (تعليقك  هنا#).

  • وسم او تاج البي اتش بي PHP

  1. كما معلوم لدينا يوجد شكلان لوسم البي اتش بي الاول هو المعيار ويفضل استخدام لانه يمكن تحميل كود البي اتش بي على عدة انظمة ومنصات ليعمل بشكل افضل وهو ().
  2. الثاني وهو الوسم المختصر ويجب تفعيل خاصية استخدام الوسم المختصر من php.ini ليعمل وهو ().

  1. استخدام الحروف الصغيرة مع الاسم.
  2. استخدام _ الشرطة التحتية للفصل مابين الكلمات.
  3. المتغيرات العامة يجب ان تبداء بالحرف g.
  4. المتغرات  الساكنة تبداء بالحرف s.
  5. المتغيرات الثابتة تبدأ بالشرطة التحتية  _ .

  • جعل الدالة يمكن استخدامها مرة أخرى 
يجب أن لا تستخدم المتغيرات الساكنة داخل الدالة لانها تمنع من استخدام الدالة مرة أخرى.

  • محاذاة الكود الى اليسار عند كتابته.
  • جملة واحدة في كل سطر.
يمكنك فيما بعد من تطوير معايير خاصة بك.



لمتابعتي
تويتر: @aalmahallawi
IT Help Desk,
SEO Arabic Expert ,PHP,C#,ASPX
Al alami st
gaza -jabalia, Gaza Strip
Palestine
Email :ahmed.almahallawi@gmail.com
DOB: 05/10/1984