الإفراط في تعقيد التسمية يؤدي إلى الفوضى

TL;DR: التسمية صعبة، لا تجعلها أكثر صعوبة من خلال التعقيد العرضي غير الضروري.

مشاكل

• الأسماء غير الواضحة والمضللة والغامضة والمبهمة

• مصطلحات زائدة

• تجريدات مربكة

• الاختصارات المبهمة

الحلول

1. تبسيط اصطلاحات التسمية

2. ضمان الاتساق

3. تجنب المصطلحات غير الضرورية

4. استخدم أسماء وصفية بناءً على السلوك

5. الحفاظ على مصطلحات متسقة

سياق

جادل لودفيج فيتجنشتاين بأن الكثير من الارتباك ينشأ من سوء استخدام اللغة.

يحدث هذا عندما تبالغ في تعقيد الأسماء، أو تخلط الاستعارات، أو تستخدم مصطلحات غير متناسقة.

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

يتسبب هذا في حدوث أخطاء، ويجعل الصيانة أكثر صعوبة، ويؤدي إلى إحباط الفريق.

رمز العينة

خطأ

public class AbstractDataHandlerManager {
    private String dtStr;

    public void execProcessingOps(String input) {
        if (dtStr != null && !dtStr.isEmpty()) {
            // process
        }
    }
}

يمين

public class SETIProcessor {

    public void processSignal(String input) {      
            // process
        }
    }
}

كشف

[X] الدليل

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

علامة أخرى هي عندما يجب عليك شرح ما يعنيه الاسم للمطورين الآخرين على سبيل المثال في مراجعة التعليمات البرمجية.

العلامات

• تسمية

مستوى

[X] مبتدئ

جيل الذكاء الاصطناعي

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

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

كشف الذكاء الاصطناعي

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

خاتمة

يؤدي الارتباك اللغوي في الكود إلى تعقيد غير ضروري.

استخدم تسمية واضحة ومتسقة ومباشرة لتسهيل قراءة التعليمات البرمجية الخاصة بك وصيانتها.

العلاقات

كود الرائحة 22 - المساعدون

ماكسي كونتيري ・ 12 نوفمبر '20

#oop #مساعدون #codenewbie #مبتدئين

كود الرائحة 38 - الأسماء المجردة

ماكسي كونتيري ・ 30 نوفمبر '20

#oop #codenewbie #تسمية #webdev

كود الرائحة 197 - سياق لا مبرر له

ماكسي كونتيري ・ 21 فبراير '23

#webdev #مبتدئين #برمجة #درس تعليمي

كود الرائحة 113 - تسمية البيانات

ماكسي كونتيري ・ 5 يناير 2022

#oop #webdev #قاعدة بيانات #إعادة البناء

مزيد من المعلومات

مفهوم فيتجنشتاين للارتباك اللغوي

ما هو (الخطأ في) البرنامج

ماكسي كونتيري ・ 8 أكتوبر 2020

#oop #صلب #مبتدئين #تصميم

ما هو الاسم بالضبط؟ — الجزء الأول: المهمة

ماكسي كونتيري ・ 9 فبراير '21

#codenewbie #درس تعليمي #webdev #oop

ما هو الاسم بالضبط - الجزء الثاني الرحاب

ماكسي كونتيري ・ 23 مايو 2021

#درس تعليمي #codenewbie #برمجة #webdev

تنصل

روائح الكود هي رأيي.

الاعتمادات

تصوير ميمي ثيان على Unsplash

أكبر عدو للغة الواضحة هو النفاق.

جورج أورويل

اقتباسات رائعة في هندسة البرمجيات

ماكسي كونتيري ・ 28 ديسمبر '20

#codenewbie #برمجة #يقتبس #برمجة

هذه المقالة جزء من سلسلة CodeSmell.

كيفية العثور على الأجزاء الكريهة من الكود الخاص بك

ماكسي كونتيري ・ 21 مايو '21

#codenewbie #درس تعليمي #جودة الكود #مبتدئين