تقييم الموضوع :
  • 0 أصوات - بمعدل 0
  • 1
  • 2
  • 3
  • 4
  • 5
Tips for clean code #1
#1
بسم الله الرحمن الرحيم
(رب اشرح لي صدري ويسر لي امري واحلل عقدة  من لساني يفقهوا قولي)

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

النقطة الاولى في اغلب لغات البرمجة هنالك نمط محدد لكتابة أسماء الدوال او الكلاسات الجاهزة وحتى الـProperties
مثلا لغة C#.NET يستخدم نمط Pascal-Case بينما لغة Java يستخدم نمط Camel-Case.
لنقم بتوضيح هذه المصطلحات:

Pascal-Case: في هذا النمط يتم كتابة المعرفات بحرف كبير بما في ذلك المعرفات المركبة.



كود :
ex: FirstName, Age, WriteLine() ....etc.

 
Camel-Case: في هذا النمط يتم كتابة المعرفات بحرف صغير، أما المعرفات المركبة تبدأ بحرف صغير للكلمة الاولى وحرف كبير للكلمات التي تليها.



كود :
ex: firstName, age, getText() .....etc.

 
وكمبرمج يفضل لك ان تختار النمط الذي تريده او حتى تختار نمطك الخاص، مثال على ذلك من الممكن ان تجعل أول حرف من المتغير اول حرف من اسمك او من الممكن ان تفصل الاسماء بفاصلة _ under score.
النقطة الثانية: وضوح اسماء الـ Identifiers المعرفات من (متغيرات، اسماء دوال، اسماء كلاسات … الخ).

مثال/ لو اردنا جمع عددين فيفضل تسمية المتغيرات بتسميات ذات معنى بالشكل التالي:



كود :
firstNum, secondNum

ولا يفضل تسمية المتغيرات بهذا الشكل:


كود :
x, y

 
أما بالنسبة لاسماء الدوال انظر الى الامثلة التالية:


كود :
Add2Num not just Add

كود :
PrintEmployeeInfo not just Print ... etc

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


PHP كود :
const int level 100;// The level mark is constant to 100 can't be changed
const decimal turnaround 45.67  // The turnaround is constant and can't be placed more 
 



تحياتي لكم
الرد
تم الشكر بواسطة: sendbad100 , قاسم , قاسم , محمد كريّم
#2
السلام عليكم
شكرا على هذا التوضيح
الله يجعل كل حرف كتبته في ميزان حسناتك
  Heart   الرجاء البحث قبل وضع السؤال  Heart

   كل عام وانتم بالف بخير.  
الرد
تم الشكر بواسطة: Sajad , Sajad
#3
(05-11-17, 10:32 PM)Sajad كتب :
بسم الله الرحمن الرحيم
(رب اشرح لي صدري ويسر لي امري واحلل عقدة  من لساني يفقهوا قولي)

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

النقطة الاولى في اغلب لغات البرمجة هنالك نمط محدد لكتابة أسماء الدوال او الكلاسات الجاهزة وحتى الـProperties
مثلا لغة C#.NET يستخدم نمط Pascal-Case بينما لغة Java يستخدم نمط Camel-Case.
لنقم بتوضيح هذه المصطلحات:

Pascal-Case: في هذا النمط يتم كتابة المعرفات بحرف كبير بما في ذلك المعرفات المركبة.



كود :
ex: FirstName, Age, WriteLine() ....etc.

 
Camel-Case: في هذا النمط يتم كتابة المعرفات بحرف صغير، أما المعرفات المركبة تبدأ بحرف صغير للكلمة الاولى وحرف كبير للكلمات التي تليها.



كود :
ex: firstName, age, getText() .....etc.

 
وكمبرمج يفضل لك ان تختار النمط الذي تريده او حتى تختار نمطك الخاص، مثال على ذلك من الممكن ان تجعل أول حرف من المتغير اول حرف من اسمك او من الممكن ان تفصل الاسماء بفاصلة _ under score.
النقطة الثانية: وضوح اسماء الـ Identifiers المعرفات من (متغيرات، اسماء دوال، اسماء كلاسات … الخ).

مثال/ لو اردنا جمع عددين فيفضل تسمية المتغيرات بتسميات ذات معنى بالشكل التالي:



كود :
firstNum, secondNum

ولا يفضل تسمية المتغيرات بهذا الشكل:


كود :
x, y

 
أما بالنسبة لاسماء الدوال انظر الى الامثلة التالية:


كود :
Add2Num not just Add

كود :
PrintEmployeeInfo not just Print ... etc

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


PHP كود :
const int level 100;// The level mark is constant to 100 can't be changed
const decimal turnaround 45.67  // The turnaround is constant and can't be placed more 
 



تحياتي لكم

شكرا لك
كنت احتاج هذه النصيحة
ربنا يبارك لك
السلام عليكم

كل الشّكر و التقدير و العرفان بالجميل و الامتنان لكل من ساعدني.
واسال لله ان يوسع له  في رزقة - ويزيدة علما وحكمه - ويكتب اجره مضاعفا - ويسعده دنيا واخرة - ويرحمه ويرحم والديه
الرد
تم الشكر بواسطة: Sajad


المواضيع المحتمل أن تكون متشابهة .
الموضوع : الكاتب الردود : المشاهدات : آخر رد
  Tips for clean code #3 Sajad 3 277 25-11-17, 12:35 AM
آخر رد: قاسم
  Tips for clean code #2 Sajad 2 182 21-11-17, 05:42 PM
آخر رد: قاسم
  Entity Framework Code First Abu Ehab 1 369 10-06-17, 03:39 PM
آخر رد: sendbad100
  Tips and tricks - مقدمة RaggiTech 1 634 14-10-12, 03:06 PM
آخر رد: RaggiTech
  Tips and Tricks : الفرق بين const و static readonly RaggiTech 0 1,049 14-10-12, 03:05 PM
آخر رد: RaggiTech
  Tips and tricks - رقم 2 - المعامل Equals والمعامل Clone RaggiTech 1 695 01-10-12, 07:43 PM
آخر رد: RaggiTech
  Tips and tricks - رقم 1 - StringBuilder RaggiTech 0 615 01-10-12, 07:39 PM
آخر رد: RaggiTech

التنقل السريع :


يقوم بقرائة الموضوع: بالاضافة الى ( 1 ) ضيف كريم