نصائح البرمجة

نصائح عامة حول كيفية كتابة الكود الجيد


تسمية الدالة

اختيار أسماء جيدة للدوال جزء أساسي من كتابة كود جيد. خُذ بعين الاعتبار التوصيات التالية عند تسمية دالتك.

اختر أسماء دوال ذات معنى

عند تسمية دالتك، ينبغي أن يكون واضحًا ما الذي تفعله. على سبيل المثال، اسم الدالة get(studentId, subject) ليس اسمًا ذا معنى، ولذلك ليس واضحًا ما الذي تفعله. فقد تُرجع درجة الطالب في مادة ما، أو حالة تسجيله. الاسم الأفضل هو getStudentGrade(studentId, subject)، لأنه يوضح بدقة ما الذي تفعله الدالة.

لا تجعل اسم الدالة طويلًا جدًا

احرص على ألا تجعل اسم الدالة طويلًا جدًا. على سبيل المثال، checkStudentFailOrPassOrMeritOrDistinction(mark) اسم دالة طويل بلا داعٍ. فكلما طال الاسم، صار تذكّره أصعب، وزادت المساحة التي يشغلها على شاشة الحاسوب.

لا تجعل اسم الدالة قصيرًا جدًا

وعلى العكس، فإن جعل اسم الدالة قصيرًا جدًا قد يُربك القرّاء أيضًا. على سبيل المثال، checkFPMD(mark) اسم دالة سيئ، لأنه ليس من الواضح مباشرة ماذا يعني 'FPMD'.

استخدم الاسم الذي يفهمه الجميع

ينبغي أن يكون اسم دالتك مفهومًا لكل من يقرأ الكود. على سبيل المثال، اسم دالة غامض مثل DeathStar() قد يكون مضحكًا بالنسبة لك، لكنه لا يوضح الغرض منه وقد يسبب ارتباكًا لمطورين آخرين يقرؤون الكود.

اختر اصطلاحًا واحدًا لتسمية العمليات

التزم باصطلاح واحد لتسمية العمليات التي تفعل الشيء نفسه. على سبيل المثال، إذا سميت الدالة التي تجلب اسم الطالب getStudentName()، فلا ينبغي أن تستخدم فعلًا مختلفًا في اسم الدالة التي تجلب درجة الطالب (مثل retrieveStudentGrade()).

تجنّب استخدام الكلمة نفسها لغرضين

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