5 نصائح لكتابة الكود بشكل أفضل

يجب عليك كمبرمج أو كمطوّر أن تهتم بطريقة كتابة أكوادك، لكي تكون سهلة الفهم وواضحة لك ولغيرك، أو على الأقل لك أنت لكي تستطيع تعديلها أو إصلاح أخطائها بسهولة بعد ذلك، وبعيدًا عن تلك النصائح سأقدم لكم معلومة فريدة من نوعها، إذا كُنت تحب أن يُطلق عليك لقب مبرمج، فأنت تحب كتابة الكود بكثرة ولكن لست منظمًا فى كتاباتك، وإن كنت تحت أن يُطلق عليك لقب مطوّر فأنت منظم بالفعل في طريقة كتابتك للأكود، ولهذا تلك التدوينة مقدمة فقط للمبرمجين !

لا أخفى عليكم أننى مبرمجًا، ولست مطوّرًا ، فهمتم الآن ما أعنيه؟ :D ... أترككم مع تلك النصائح الخمس.

1- التعليقات والمستندات.

تلك هي الحقيقة التي لا يُريد أى مبرمج الإعتراف بها، وهي أن التعليقات هي شيء أساسي لا يُمكن الإستغناء عنه لجعل الكود نظيفًا وسهلاً فى التعامل، وحتى وإن كانت مجرد كلمات سريعة تفي بالغرض، المهم أن نترك بعض الكلمات التي تشرح وظيفة كل سطر، أما بالنسبة للمستندات الخاصة بالدوال والكلاسات، فإنه لشيء رائع أن تقوم بذلك !

2- أعطي المتغيرات، الدوال والكلاسات أسماءًا ذات معنى.

من الصعب تخمين قيمة متغير ما إن كان اسمه مثلاً var1 ، ولكن من السهل جدًا تخمين قيمة متغير ما إن كان اسمه site_name، أليس كذلك؟!

وأيضًا من السهل تخمين وظيفة الدالة التى تحمل اسم add_article، عن دالة تحمل اسم do_art، أليس كذلك؟!

لذلك ولتجعل من الكود أسهل فى الفهم يجب عليك أن تُعطي المتغيرات والثوابت والدوال والكلاسات اسماءًا ذات معنى ومعبرة عن وظيفتها أو القيمة التي تحملها.

3- المساحات البيضاء.

كما ترى فى تلك الصورة، القليل من المساحات البيضاء قد تجعل الحياة أكثر سهولة !

4- لا تحذف تعليقًا ابدًا.

لنتخيل أنك واجعت خطأ فى كود مكون من 100 سطر، والمائة سطر يحتوون على تعليقات، وانت قمت بالمرور على جميع تلك الأسطر وقمت بإصلاح كل الأخطاء التي بتلك السطور، وفى أثناء ذلك تخيل أنك قمت بحذف التعليقات الموجودة فى تلك السطور، وعند تجربة البرنامج وجدت أن هنالك خطأً ما قد أرتكبته أنت أثناء إصلاحك لتلك الأخطاء، فما الحل الآن؟

سيصعب عليك فعليًا فهم كل تلك الأكواد مرة أخرى بدون تعليقات، لذلك لا تحذف ابدًا آية تعليقات.

5- استخدم الـBraces.

الـBraces هي تلك الأقواس  {} ، فهي بطبيعة الحال أفضل من كثير من الطرق البديلة، لكن الـBraces ستكون أكثر إفادةً وأكثر جمالاً فى الكود إن قمت بتنظيم الكود بشكل جيد، حسنًا لتستوعب تلك النقطة سأعطيك مثالاً على كود مزعج وكود نظيف ومنظم.

<?php
/* Examples of annoying code */
if ( $coder === 'Silly' ) bang_head();
while ( $coder === 'Silly' )
bang_head();
endwhile;

/* Examples of good code*/
if ( $coder !== 'Silly' ){ Drink_Beer(); }
while ( $coder !== 'Silly' ){
Drink_Beer();
}
?>

هل ستهتم بتلك النصائح الآن؟ أم ستهملها كحال معظم المبرمجين العرب؟؟!

المزيد من المواضيع:

---