الفريق العربي للبرمجةأرشيف المنتديات · 2000 – 2023
نسخة أرشيفية للقراءة فقط — التسجيل والمشاركة مغلقان، والمحتوى محفوظ كما كان.

المواصفات القياسية للكود

مغلق
بدأه محمد حمود في 24 مايو 2005 · 4 رد · 1,826 مشاهدة · في الأخبار والنقاشات التقنية
مشاركة: واتساب X فيسبوك تيليجرام
#1 صاحب الموضوع

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

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

ولذلك يجب على الشركات والمؤسسات العاملة في مجال البرمجة أن تضع معايير ومواصفات قياسية لكتابة الأكواد ولتصميم الواجهات لجميع لغات البرمجة المستخدمة فيها، أو مايطلق عليه "Coding Standards". ويجب على جميع المبرمجين أن يلتزموا بتلك المواصفات العامة إلى درجة لايمكن من خلالها معرفة من كتب كوداً معيناً من خلال أسلوبه، وذلك لأن الجميع يتبع أسلوباً واحداً، وهكذا فسيكون من السهل لمبرمج جديد قادم إلى المؤسسة أن يفهم كودات من سبقوه بسهولة، وسيتمكن كل مبرمج من فهم ماكتبه زميله بسهولة وأن يتمكن من متابعة عمل زميل له غادر الشركة أو ذهب في إجازة.

أمثلة على المواصفات القياسية التي يمكن وضعها للكود:

1- استخدم أسماء انكليزية لكتابة المتغيرات، واستخدم الأحرف الصغيرة فقط في اسم المتغير واستخدم الرمز "_" في حال كان اسم المتغير مكوناً من أكثر من كلمة:

'مقبول:
Dim employee_age as integer

'غير مقبول:
Dim EmployeeAge as integer

Dim Omr_Al_Mowazaf as integer

2- في عبارات sql استخدم الأحرف الكبيرة للكلمات المفتاحية:

'مقبول
sql="SELECT * FROM my_table"

'غير مقبول
sql="select * from my_table"

بنفس الطريقة يمكن وضع مواصفات قياسية لكل شيء من تسمية الجداول والحقول في قواعد البيانات، إلى اسماء الكائنات والفئات (classes) وطريقة استخدام التوابع (functions) وحتى شكل الواجهة وأبعاد الأزرار وألوان الأدوات ونوع الخط المستخدم وأحجامه ومكتبة الأيقونات والمؤشرات التي يجب استخدامها...

يمكنكم الاطلاع على المواصفات القياسية لكتابة الكود في مشروع منتدى phpbb الشهير مفتوح المصدر والذي يتشارك في كتابته عدد كبير من المبرمجين من أنحاء العالم:

http://area51.phpbb.com/docs/coding-guidelines.html

والآن شاركونا النقاش، هل لدى المؤسسة التي تعملون بها مواصفات قياسية لكتابة الكود؟ وماهي؟

محمد حمود

ماجستير تقنية المعلومات

بكالوريوس هندسة مدنية

محترف إدارة مشاريع (PMP)

مهندس جودة البرمجيات (CSQE)

مبرمج معتمد من مايكروسوفت (MCP)

متخصص في نظم المعلومات الجغرافية GIS

mohamed.hammod(at)gmail.com

www.ShapeViewer.com

#2

جزاك الله خيرا , فان عملية كتابة الأكواد بالشكل الصحيح هى بداية نجاح العمل الجماعي.

انا لا أعمل لدى مؤسسه , لكن حبيت أضيف.

عموما انا قرات ان اسماء الـ المتغيرات تبدأ هكذا مثلا ( أول حرف في أول كلمه يكون صغير وأول حروف الكلمات التاليه تكون كبيره ::

string myOwnVariable;

واسماء الدوال تبدأ هكذا مثلا مع مراعاة كتابة حروف أول الكلمات كلها كبيره ::

void MyMethodName()
{
Body;
}

واذا كان لديك Properties , فيفضل ان تكتب اسم الـ Field مثلا هكذا بجعل أول حرف منه بشكل صغير وتجعله Private ::

private string name;

وتكتب الـ Property بتاعته مثلا هكذا مع جعل أول حرف فيها كبير ::

public string Name
{
get{ return name; }
set{ name = value; }
}

#Read

http://MoutazShams.blogspot.com

projects003.gif

أعتذر عن التغيب هذه الأيام نظرا للانشغال المريب

#3

بالضبط كما قال معتز

استخدام ال_ Underscore في اسماء الvariables في البرمجة غير مستحب في اغلب الnotations عدا الhangarian الذي يضع اول حرف يدل على نوع المتغير و _ ثم اسم المتغير مثل m_myObjct و الm تعني member of a class يعني object او i_age و تعني ان age من نوع Integer

و لكن عامة في ال java مثلا لا تستخدم ال_ ابدا في اسماء الvariables او الfunctions

فالnotation الاساسي هو ان يكتب المتغير اذا كان من كلمة واحدة كله small letters و اذا كان يتكون من اكثر من مقطع يكون بداية كل مقطع عدى الاول captical مثال

name متغير من مقطع واحد

firstName متغير من مقطعين

و كذلك في اسماء الfunctions

getNameو setFirstName

اما الclasses فيجب ان تبدا بحرف Capital

مثل class Person

Person person = new Person()

اما في ال#C فهناك اختلاف بسيط

في اسماء الfunctions و الproperties فان الحرف الاول دائما capital

فاذا كان اسم المتغير الprivate داخل الclass مثلا name فان الaccessor او الproperty الخاصة به تكون Name

و لكن اي function يجب ان تبدأ ب Capital مثل Console.WriteLine و ايضا اسماء الclasses

اما فصل اسماء الvariables باستخدام ال_ لا يستخدم الا في الDatabase Notation مثل

First_Name او Last_Name او Birth_Date و استخدام الحرف الول Capital او Small ليس ضروريا و لكن في الDBMS التي تتبع الCase Sensitive يجب الحذر لان First_Name لا تكافئ first_name

Sr. Software Development Engineer
Hulu, LLC
My Blogs

#4

مثلا موقع مثل phpfreaks يقدم دروس فى المعايير php coding standards

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

فى البيشو لا تستخدم الشارب للتعليق #

إنما نستخدم السلاش سلاش //

:)

#5

الأخوة معتز شمس وبشمهندس، أنا لم أقصد أن أعطي طريقة صحيحة لكتابة الأكواد، حيث أن أي طريقة هي مقبولة طالما أنها موحدة بين فريق العمل في المؤسسة، وطبعاً يفضل أن تكون موحدة نوعاً ما مع المعايير العالمية، وذلك لأنه لايوجد معيار عالمي واحد.

محمد حمود

ماجستير تقنية المعلومات

بكالوريوس هندسة مدنية

محترف إدارة مشاريع (PMP)

مهندس جودة البرمجيات (CSQE)

مبرمج معتمد من مايكروسوفت (MCP)

متخصص في نظم المعلومات الجغرافية GIS

mohamed.hammod(at)gmail.com

www.ShapeViewer.com

هذا الموضوع مغلق.

مواضيع مشابهة