التسمية في البرنامج، درس لابد من أن يقرأه كل مبرمج!

Spread the love

التسمية في البرنامج، درس لابد من أن يقرأه كل مبرمج!

(بواسطة : رسيــــس | بتاريخ : 6 فبراير 2004 )

 

بسم الله الرحمن الرحيم

-=-=-=-=-=-=-=-

كثيرٌ منّا يبحث عن بعض الـcodes على الانترنت، وقليل منّا من يقرأ ويفهم ما يجده بسرعة وسهولة، نظراً لكثرة المتغيرات في الـcode وتداخل أسماءها!
بعد قراءتك لهذا الدرس، وتعرفك على القواعد والملاحظات التي يجب أن تأخذ بعين الاعتبار حينما تختار أسماءاً للمتغيرات في برنامجك، ستكتب برامجك بطريقة احترافية، وتقرأ وتفهم برامج المحترفين بسهولة وسرعة إن شاء الله 🙂

عند كتابتك للبرنامج، لابد من ملاحظة القاعدات التالية عند تسميّة المتغيرات:

  • أن يبدأ اسم كل متغير بأي حرف من حروف الأبجدية، أو رمز الـ underscore  فقط من بين الرموز، ولا يمكنك بدء الاسم برقم!
  • بعد الحرف الأول يمكنك استخدام أحرف أو أرقام أو حتى underscore .
  • يمنع استخدام الكلمات المحجوزة للغة التي تبرمج بها Keywords كأسماء لمتغيراتك.
  • إذا استخدمت تسميّة غير صحيحة، سيعطيك المفسّر compiler خطأ compile-time error.

أما الملاحظات التي لابد لك من معرفتها هي:

  • لديك الحرية المطلقة بجعل اسم المتغير بحروف كبيرة uppercase، ولكن مظهر برنامجك لن يكون مريحاً.
    يفضل استخدام هذه الطريقة فقط عند اختيار أسماء للثوابت CONSTs في برنامجك!
  • لديك الحرية المطلقة بأن تبدأ اسم المتغير بـunderscore، ولكن هذه الطريقة لا يستخدمها المحترفين وإنما يستخدمها مبرمجوا الطراز القديم.
  • لديك الحرية المطلقة بجعل اسماء المتغيرات عبارة عن اختصارات مفهومة بالنسبة لك كمبرمج، ولكن هذه الطريقة لن تجعل برنامجك سهل القراءة من قبل مبرمج آخر!
  • لجعل مظهر برنامجك أكثر احترافية، في الاسماء المركبة من أكثر من كلمة استخدم PascalCasing naming or camelCasing naming كما سيأتي شرحه.

-=-=-=-=-=-=-=-

PascalCasing Naming Convention:

لاستخدام PascalCasing Naming Convention، اجعل أول حرف من كل كلمة بشكل capital، وباقي أحرف الكلمة small. استخدم هذا الطريقة في تسمية كلاً من:

  • الفئات classes.
  • الطرق methods أو الدوال functions.
  • الخصائص properties.
  • الكائنات الجديدة enums.
  • الواجهات interfaces.
  • الثوابت read only and constant.
  • namespaces or packages.

أمثلة على ذلك على ذلك:

[C]
void InitilaizeData ( );  /* multiple-word name*/

[Visual Basic]
Public Class FileStream /* multiple-word name*/
Public Class Button
Public Class String

[C#]
public class FileStream /* multiple-word name*/
public class Button
public class String

-=-=-=-=-=-=-=-

camelCasing Naming Convention:

لاستخدام camelCasing Naming Convention:، اجعل أول حرف من كل كلمة بشكل capital باستثناء الكلمة الأولى، استخدم هذه الطريقة في تسمية:

  • المتغيرات variables.
  • المعاملات parameters or arguments.

أمثلة على ذلك:

[C]
int loopCountMax; /* multiple-word name*/
char flower;

[Visual Basic]
GetType(typeName As String)As Type /* multiple-word name*/
Format(format As String, args() As object)As String

[C#]
Type GetType(string typeName) /* multiple-word name*/
string Format(string format, object[] args)

ملاحظة:
سمّيت هذه الطريقة بـcamelCasing لأن ظهور حرف كبير في وسط الاسم المركب يشبه نتوء السنام في الجمل:

-=-=-=-=-=-=-=-

وفي نهاية درسنا، تذكر أن اسم المتغير يفضّل أن يكون اسماً له معنى مختص بعمل المتغير في البرنامج، فمثلاً لو مثّل المتغيّر عداداً في البرنامج، يفضّل أن تسميه counter بدلاً من i أو j. ولو كنت تكتب class لبرنامج مختص بشركتك، يفضل أن تكتب اسم الشركة Computer4Arab مثلاً بدلاً من أن تكتب MyCompany.
وبالنسبة لصيغة الجمع او المفرد، فإن ذلك لا يشكل أي فارق ويرجع لحس المبرمج، ولكن يفضل استخدام صيغة الجمع فقط مع namespaces or packeges.

للمزيد، يمكنك قراءة مرشد تعليمات التسميات Naming Guidelines في SDK Help documentation، أو من هنا:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpconnamingguidelines.asp

أرجو أن يكون درسي البسيط قد أضاف إليك الجديد، والسلام عليكم 🙂

-=-=-=-=-=-=-=-

 

الكاتب geek4arab

geek4arab

مواضيع متعلقة

التعليقات مغلقة