Coding Standard

من احد اكبر العوامل في سهوله متابعة وتصحيح البرامج هو طريقه كتابتها ، نعم ، ففي حال تم كتابة البرنامج بصوره واضحه ومرتبه تكون عمليه التصحيح والتتبع امر في منتهي السهوله ..

بالاضافه الى انه اغلب الشركات والمؤسسات تتبع اسلوب معين في كتابه البرامج من ناحيه تسميه المتغيرات والثوابت وطريقه كتابه البرنامج حتى يستطيع باقي المبرمجين التعامل معها .

ولو نظرنا الى طلاب جامعتنا الموقرين ، لوجدنا انه اغلب برامجهم عباره عن طلاسم !! فلن تستطيع فهم اي سطر الا بعد التعديل هنا وهناك .

ومن هنا كان يجب ان ننوه عن هذا الموضوع ولو بمجرد ملاحظات بسيطه ، ( سوف يكون الحديث هنا عن كيفيه كتابه البرنامج من ناحيه تسميه المتغيرات وطرق التوثيق Comments  ، ولن اتكلم عن طرق تحسين البرنامج optimization ولا عن افضليه اختيار طريقه من اخرى لانه ببساطه موضوع اخر ويدخل ضمن Programming Skills) .

تسميه المتغيرات :

وهنا يجب ان يكون اسم المتغير يدل على وظيفته ، فلو كان لدينا متغير عددي صحيح يستخدم لتخزين رقم الطالب فيصبح اسم المتغير :

int studentNumber ;

char studentName[10];

وهكذا بالنسبه الى بقيه المتغيرات التي تستخدم داخل البرنامج ..

حاله خاصه وهي المتغيرات التي تستخدم كعدادات counter ، وجرت العاده من ايام لغه الفورتران حيث كانت لا تسمح باستخدام عدادات الا بالاسماء : i,j,k,l,m... etc ..

(etc -- يشير الى "الى اخره" ، وليس الى اسم متغير :) ).

حسنا ، هناك ثلاث طرق مستخدمه في تسميه المتغيرات وهي التي يتبعها اغلب المبرمجين في العالم ، وطبعا تستطيع استخدام النمط او الاسلوب الذي يعجبك .

النوع الاول : underscore notation :

وهنا في هذا النمط يجب استخدام الشرطه السفلي (underscore) للفصل بين الكلام في اسم المتغير

مثال :

int student_number ;

char student_name[10];

وهذا الاسلوب لا يستخدم بكثره ، لانه متعب ، يعني حتى اضغط المفتاح shift ثم بالاصبع الاخر - ، الامر طويل وخاصه نحن شعب كسول :) .

النوع الثاني : camel Notation :

او اسلوب الجمل ، لا تستغرب من الاسم لانه في الحقيقه يدل على نوعه . في هذا النوع يتم استخدام الحرف الكبير Capital letter في كل كلمه ابتداء من الكلمه الثانيه . (يشبه سنام الجمل) .

مثال :

int studentNumber ;

char studentName[10];

وهذا النوع منتشر وبكثره واغلب الكتب تستخدمه ، وانا ايضا استخدمه . (ايضا هو يستخدم في تسميه الداول function ).

النوع الثالث : hangarain notation :

التسميه الهنغاريه ، وهي تسميه اخترعها احد مبرمجين شركه مايكروسوفت ، وتستخدم في تسميه برامج الويندوز التي تستخدم دوال API وايضا برامج سي++ المكتوبه بالمكتبه MFC .

طريقتها : هي ان نضع حرف في بدايه اسم المتغير للدلاله على نوعه ، الحرف n يدل على عدد صحيح

مثال :

int nStudentNumber ;

char cStudentName[10];

تسميه الدوال Function والفئات classes :

-

يفضل في تسميه الدوال استخدام الـ Camel Notation ، وفي لغه جافا جميع الدوال الموجوده في المكتبات مكتوبه بهذا الاسلوب ..

بالنسبه الى تسميه الفئات او الطبقات classes ، فكل حرف من كل كلمه يكون بالحرف الكبير Capital letter مثال :

class MyCar

class CheckBox

تسميه الثوابت :

هنا جميع الحروف تكون بالحرف الكبير Capital letter ..

مثال :

const int MAX = 10 ; // here in c++ only

final int MAX = 10 ;        // here in java 

التوثيق ، التوثيق :

احد العوامل المساعده في فهم البرامج هي التوثيق وكتابه التعليقات ، بالطبع هذه الخاصيه مختفيه جدا لدى جميع الطلاب وكأنها امر غير ضروري !! . (المفترض ان يتم محاسبه  الطلاب في حال قيامهم بكتابه برنامج بدون تعليقات) .

طبعا كتابه التعليق لن تكون في اي جمله واي مكان ...

مثال :

int studnetNumber ;    // this is number of student

هذا التعليق متخلف جدا ان صح التعبير ، لان اسم المتغير يدل على فعله Self-Document (لذلك كما اشرنا سابقا ، التسميه عامل من اهم العوامل ) .

يكون التعليق لتوضيح عمل داله معينه مثلا قمت بكتابه داله معينه ، عليك بكتابه تعليق يوضح الغرض من هذه الداله ، هل هناك مدخلات ، هل هناك مخرجات ، وهكذا ...  (فقط يكون قبل الداله) ..

ايضا تستخدم التعليقات في بدايه البرنامج ، لوضع معلومات حول المبرمج ، اسمه ، وبريده الالكتروني ، ايضا تكون هناك معلومات حول المترجم المستخدم ، ووقت كتابه البرنامج ..

تنسيق الكود نفسه :

هنا اقصد بدايات ونهايات البرنامج (او اي block) تكون في سطر خاص بهما ،

مثال :

for (int i=0 ; i<10 ; i++ )

{

cout << "hi i Study in Neelian University \n" ;

cout << "and i love Computer Sceince\n" ;

}

(لاحظ بدايه ونهايه الـ Block تكون في سطر خاص بهما ، وجسم الحلقه (او الداله بنفس الطريقه) يكون في سطر ويكون مبتعد عن بدايه السطر بمقدار 8 حروف (بالضغط على مفتاح tap ).

كانت هذه لفته بسيطه ، على امل ان  تتحول تلك الطلاسم الى برامج مقروئه ، وتتغير طريقه كتابتكم للبرامج بطريقه افضل ...

تحياتي ..

romansy