Чрезмерное усложнение именования приводит к хаосу

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] Новичок

Поколение ИИ

Генераторы искусственного интеллекта часто создают этот запах, создавая многословные и общие имена, которые пытаются охватить все возможные контексты.

Они являются экспертами во многих областях и пишут код, но часто не делают и то и другое одновременно, если их не проинструктировать.

Обнаружение ИИ

Генераторы искусственного интеллекта иногда могут исправить этот запах с помощью простых инструкций по рефакторингу, таких как «упростить имена» или «удалить лишние термины», но им сложно добиться более глубокого понимания контекста.

Заключение

Лингвистическая путаница в коде приводит к ненужной сложности.

Используйте четкое, последовательное и понятное именование, чтобы код было легче читать и поддерживать.

Отношения

Код Smell 22 — Помощники

Макси Контьери ・ 12 нояб. 2020 г.

#ой #помощники #codenewbie #новички

Код Smell 38 – абстрактные имена

Макси Контьери ・ 30 нояб. 2020 г.

#ой #codenewbie #именование #webdev

Код Smell 197 – Необоснованный контекст

Макси Контьери ・ 21 фев. 2023 г.

#webdev #новички #программирование #учебник

Код Smell 113 – Именование данных

Макси Контьери ・ 5 янв. 2022 г.

#ой #webdev #база данных #рефакторинг

Дополнительная информация

Концепция Витгенштейна о языковой путанице

Что такое (не так) программное обеспечение

Макси Контьери ・ 8 окт. 2020 г.

#ой #твердый #новички #дизайн

Что такое имя? — Часть I: Квест

Макси Контьери ・ 9 фев. 2021 г.

#codenewbie #учебник #webdev #ой

Какое именно имя - Часть II Реабилитация

Макси Контьери ・ 23 мая 2021 г.

#учебник #codenewbie #программирование #webdev

Отказ от ответственности

Кодовые запахи — мое мнение.

Кредиты

Фото Мими Тиан на Unsplash

Самый большой враг ясного языка — неискренность.

Джордж Оруэлл

Великие цитаты о программной инженерии

Макси Контьери ・ 28 дек. 2020 г.

#codenewbie #программирование #кавычки #программное обеспечение

Эта статья входит в серию CodeSmell.

Как найти ненужные части вашего кода

Макси Контьери ・ 21 мая 2021 г.

#codenewbie #учебник #качество кода #новички