- الملف و الإزاحة وطول السطر Indenting and Line Length :
* يجب استخدام الصيغة الطويلة في الملف وعدم استخدام لبدء ونهاية الكود .
* يجب ان تكون الإزاحة أربع فراغات بدون إستخدام زر tab .
* طول السطر يكون بين 70 الى 85 حرف .
* تستخدم صيغة لينكس للسطر الجديد LF و ليس CR او CRLF والتى تعني n وليس r او rn.
* يجب أن ينتهي الملف بسطر جديد LF بعد التعليمة ?>.
- التسمية :
رمز Code:
examplefilename.php;
$example_variable = true;
definde(EXAMPLE_VARIABLE,true);
example_function();
ExampleClass {
function ExampleFunction();
}
* يجب أن تكون التسمية واضحة وتدل على شيء .
* تسمية الملفات يكون بأحرف صغيره و مسار الملف php .
* تسمية المتغيرات تكون بأحرف صغيره ويفصل بين الكلمات بشرطة سفلية.
* تسمية الثوابت تكون بأحرف كبير ويفصل بين الكلمات بشرطة سفلية.
* تسمية الدوال تكون بأحرف صغيرة ويفصل بين الكلمات بشرطة سفلية.
* تسمية الأصناف بحرف كبير في البداية وبداية كل كلمة من اسم الصنف.
* تسمية الدوال داخل الصنف تكون مثل تسمية الصنف .
* تسمية المتغييرات داخل الصنف مثل تسمية المتغييرات .
- تعليمات التحكم Control Structures :
* تشمل كلن من if, for, while, switch وغيره .
رمز PHP:
* التعليمة: تكتب في سطر لوحدها وايضا قوس ويتنهي السطر بعد قوس بداية التعليمة .
* الفراغات: يجب أن يكون هناك فراغ واحد يفصل بين التعليمة وبين محتواها وبين اقواس التعليمة نفسها وايضا بين علامات المقارنة و الشروط.
* علامات المقارنة: يجب ان تستخدم العلامات (&& و ||)بدلا من كلماتها (AND و OR ) .
* الشروط: يوضع كل شرط في قوس لوحده .
- منادات الدوال Function Calls
رمز PHP:
* يجب منادات الدلة بدون فراغ بين أسمها وقوس البداية .
* يجب كتابة معطيات الداله والفصل بينها بفراغ واحد فقط يكون بعد الفاصلة وليس قبلها .
* لا يجب ان يكون هناك فراغ بين اول معطى وبين القوس وكذلك بين اخر محطى وقوس نهاية الداله .
رمز PHP:
* إزاحة علامة المساواه عندما يكون هناك متغير يحتوى على اسم قصير واخر اسم طويل حتى تزيد من قابلية قرائة الكود .
- تعريف الأصناف Class Definitions
رمز PHP:
* أقواس تعريف الصنف يكون كل قوس في سطر لوحده ويتم ازاحة الكود بداخل الصنف.
- تعريف الدوال Function Definitions
رمز PHP:
* قوس بداية تعريف الداله يكون في السطر الذي يلي تعريف الداله ويتم وضع ازالة للكود داخل الدالة.
* المعطيات التى تكون لها قيم افتراضية تكون في اخر قائمة المعطيات .
* يجب ان تعيد الداله قيمة بالتعليمة return .
- التعليقات Comments
رمز PHP:
/*
* More than one lines
* ....
*/
// single Line
* More than one lines
* ....
*/
// single Line
* يجب استخدام الشرطة المائلة مع نجمة للكتابة تعليق اكثر من سطر.
* استخدام الشرطة المائلة المكررة لكتابة تعليق من سطر واحد وعدم استخدام الرمز # .
المرجع Manual :: Coding Standards
