تعرف على المعايير الصحيحة لكتابة الأكواد Kebab Case - Snake Case - Pascal case

تعرف على المعايير الصحيحة لكتابة الأكواد Kebab Case - Snake Case - Pascal case

شارك هذا المقال:



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

كيف بدأت المشكلة في الأساس؟

لا يتم انشاء المعايير بشكل عشوائي, غالباً ما يتم انشائها لحل مشكلة معينة متكررة او لاضافة المزيد من المرونة على عملية تطوير البرمجيات, و تم استحداث معايير لكتابة الأكواد لحل مشكلتيين أساسيتين:

1- تجنب الخطأ الشهير Syntax Error

2- توقع طريقة محددة لكتابة الكود و ممارستها من جميع المبرمجين في الفريق

لنأخذ مثالاً سريعاً هنا, لنفترض ان لديك متغير يحفظ قيمة من نوع Boolean و هي البريد الإلكتروني الخاص بالمستخدم, كما ذكرنا في مقال سابق عن أهمية اختيار أسماء منطقية للمتغيرات, غالباً ما ستقوم بتسمية المتغير الخاص بك user email, و هنا انت بحاجة الى كلمتين لوصف هذا المتغير, في الكلمة الأولى ستوصف العنصر العائد عليه المتغير user و الكلمة الثانية ستوصف البيانات المحفوظة في هذا المتغير, لكن كما نعلم جميعاً لا يمكننا استخدام المسافة Space في أسماء المتغيرات لأنها تعتبر حرف مميز Special Charachter و غالباً ما تتعارض مع عملية قراءة ال Compiler للبرنامج, و من ثم سنحصل على الخطأ الشهير Syntax Error, أنظر الى الكود التالي:

<?php
$user email = "[email protected]"; // This is a syntax error
// Possible Alternatives
$user_email =  "[email protected]";
$userEmail =  "[email protected]";
$UserEmail =  "[email protected]";
$useremail =  "[email protected]"; // This is hard to read

اذا المشكلة الرئيسية بالمسافة, و كما ترى في المثال السابق يوجد عدة اتجاهات للحل, جميع الأمثلة السابقة صحيحة و ستعمل بشكل طبيعي (في لغة php), فكيف اذاً نقرر الطريقة الأمثل لكتابة الكود؟ هنا يأتي دور المعايير الصحيحة لكتابة الكود ...

يوجد عدة معايير شهيرة لكتابة الكود, لنبدأ أولاً ب camelCase

Camel Case

تأتي تسميتها من سنام الجمل, تستخدم كثيراً في كتابة أكواد ال Backend وكتابة أكواد الجافاسكريبت المعايير الخاصة بها كالتالي:

1- تبدأ بحرف صغير

2- يتم فصل الكلمات بحرف كبير

أمثلة على Camel Case

<?php
$UserEmail = "[email protected]";
$userEmail =  "[email protected]";

Kebab Case

نعم! كباب :), تستخدم فقط في كتابة أكواد ال Frontend و تحديداً ال CSS Classes و HTML Selectors و المعايير الخاصة بها كالتالي:

1- تبدأ بحرف صغير

2- يتم فصل الكلمات بخط علوي Dash -

3- لا يتم استخدام الحروف الكبيرة

أمثلة على Kebab Case

.class-name {}
#id-name {}

Snake Case

snake و هو الثعبان , تستخدم غالباً في كتابة أكواد ال Backend و المعايير الخاصة بها كالتالي:

1- تبدأ بحرف صغير

2- يتم فصل الكلمات بخط سفلي Underscore _

أمثلة على Snake Case

user_email = "[email protected]"
very_long_variable_name = true
I_AM_A_SNAKE = true # Valid snake case, invalid Ruby code however
# We can also use it for functions
def method_name do
      # Since almost everything is an object in Ruby, we call a function method :D
end

Pascal Case

Pascal case هي طريقة كتابة مشتقة من Camel case , تستخدم غالباً في كتابة أكواد ال Backend و المعايير الخاصة بها كالتالي:

1- تبدأ بحرف كبير

2- يتم فصل الكلمات بحرف كبير

أمثلة على Pascal Case

let PascalCaseVar = true;
let ThisIsValid = true;

تعلم معايير البرمجة لتصبح مبرمج أفضل

المحترفون لديهم معايير, لا يمكنك أن تكون مبرمج محترف و متمكن ان لم تكن على دراية كافية بمعايير البرمجة, يمكنك البدء الآن بتعلم هذه المعايير عبر زيارة مقالنا السابق: 8 خطوات عليك معرفتها لتصبح مبرمج أفضل كما يمكنك الانضمام لدورة علوم الحاسوب من أكاديمية حسوب العربية التي تشرح لك الكثير من القواعد و الأساسيات التي تساعدك على أن تكون مطور برمجيات أفضل!



ما رأيك في هذا المقال؟

كيف تقييم نوعية المحتوى في نقرة؟

5 4 3 2 1