"[سجن البرمجة] ستايل البرمجة - كود مرتّب (1)"

ترتيب الأداة الشرطية

أهم أشياء يجب الآنتباه لها خلال ترتيب الأداة الشرطية
1- التعليق على كل جزء من الأداة لأن الأداة الشرطية هي أكثر أداة تؤخر المبرمجين
في تطوير البرنامج لذلك اشرح كل جزء حتى تعرف ما عملها في المستقبل
2- المسافات بعد } مهمة جداً جداً ..
مثال على المسافات

PLAIN TEXT
PHP:
  1. Conditional Statement
  2. {
  3.     echo "Out Man ..";
  4. }

ألاحظت المسافة بين echo و أول السطر .. !؟؟
كذلك هنالك ملاحظة مهمة على ترتيب الجمل الشرطية
عدم دمج جملتين في سطر واحد

او وضع أكثر من } في نفس السطر كالتالي .. :

PLAIN TEXT
PHP:
  1. Conditional Statement{echo "Out Man ..";}else{
  2. echo "do some thing";}

كما ترى الكود السابق سلطة جميلة ..
الآن سنستعرض معاً ترتيب بعضاً من أوامر و دوال اللغة ..
أولاًً - جملة IF :
من المفترض أن نشرح عمل هذه الأداة ومن ثم نشرح ماذا تقوم به كالتالي

PLAIN TEXT
PHP:
  1. //What to do ?
  2. if ($_GET['do'] == "show")
  3. {
  4. // Show the program
  5. echo "hi Man .. ";
  6. }
  7. // if $_GET['do'] != show
  8. else
  9. {
  10. // Do this statement
  11. echo "Out Man ..";
  12. } // The End

كما ترى شرحنا ماذا تفعل هذه الدالة
ومن ثم علقنا على الكلام
لاحظ هنالك مسافات
ثانياًً - جملة else + elseif :
الآن في حالة الجملة الشرطية المتشعبة ..

PLAIN TEXT
PHP:
  1. //What to do ?
  2. if ($_GET['do'] == "show")
  3. {
  4. // Show the program
  5. // أكتب برنامجك هنا
  6. }
  7. // else the last statement if the (do)'s = play
  8. elseif ($_GET['do'] == "play")
  9. {
  10. // Play the program
  11. // Play Here
  12. }
  13. //else all that
  14. else
  15. {
  16. // Do this statement
  17. // code Here
  18. }
  19. // The End

ثالثاًً - جملة switch :
الآن نتطرق لترتيب وتعليق جملة switch الذي تعتبر إحدى الجمل الشرطية طبعاًً

PLAIN TEXT
PHP:
  1. // Switch the variable $x
  2. switch ($x)
  3. {
  4. // case $x == 1
  5. case 1:
  6. // echo the num 1 .
  7. echo "Number 1";
  8. // Break case 1 .
  9. break;
  10.  
  11. // case $x == 2
  12. case 2:
  13. // echo the num 2
  14. echo "Number 2";
  15. // Break case 2 .
  16. break;
  17. // the default if none of the last statements right
  18. default:
  19. // echo no num
  20. echo "No number";
  21. }

الشيفرات البرمجية السابقة توضح ما أرمي إليه ..
كما لاحظنا :
تعليق لكل سطر
مسطرة بين سطر و آخر
وكأن الكود نظف بالغسالة (فول اتوماتيك مع برسيل ) :D

ترتيب الـ Functions & : Classes

ما فائدة ترتيب الـ Function أو الـ Class ؟؟
السؤال السابق قد يجول في خاطرك و تبحث عن إجابته ..
الفائدة وبكل بساطة هي تنظيم عمل الـ class أو Function
فأن ترتيب الـ Class يؤدي لترتيب الـ Functions التي يحتويها هذا الكلاس ومن ثم إفادة في تطوير البرنامج مستقبلياً ..
و إراحة المطورين لبرنامجك ،، لأن الـ Class يعتبر لبنة الأساس في البرامج الراقية - وضع خط تحت الراقية -
كيف يمكنني ترتيب الـ Class أو الـ Function ؟
أولاً دعونا نتفق على أن نشرح الـ Class لأنه شامل للـ Functions ..
نقوم في بداية الـ Class بشرح عمل هذا الكلاس ومن ثم تفصيل عمل كل Function داخله مع ملاحظة المسافات في حالة } (كما في حالة الـ IF)
مثال :

PLAIN TEXT
PHP:
  1. /*-------------------------------------------------------|
  2. Name : Common
  3. --------------------------------------------|
  4. Describe : including common functions to help me in
  5. the program.
  6. --------------------------------------------|
  7. Author : Dr.Nabhan
  8. --------------------------------------------|
  9. Last Update : 24/9/2005
  10. --------------------------------------------------------*/
  11. Class common
  12. {
  13. # Function : Began head (To began the tag head) #
  14. function head ()
  15. {
  16. echo "";
  17. }
  18. # Function : close head (To close the tag head) #
  19. function head ()
  20. {
  21. echo "";
  22. }
  23. }

كما نرى بدأنا الـ Class بمقدمة بسيطة عن عمله و اسمه ... الخ .
ومن ثم قمنا بتفصيل كل function داخل الكلاس بحيث نصف عمله
ولاحظ المسافات بين كلمة function وبداية السطر .. وكذلك بين echo وبداية السطر
إنها تريح النظر عندما تفحص كل فانكشن.
ولا تحتاج لخبراء في تحليل الخطوط و نظارات وتلسكوب كي تحلل هذا الفانكشن .