Список тревожных сигналов программного кода:
𝟭. 𝗦𝗵𝗮𝗹𝗹𝗼𝘄 𝗺𝗼𝗱𝘂𝗹𝗲. Интерфейс класса или метода не намного проще, чем реализация
𝟮. 𝗜𝗻𝗳𝗼𝗿𝗺𝗮𝘁𝗶𝗼𝗻 𝗹𝗲𝗮𝗸𝗮𝗴𝗲. Решение по дизайну системы отражается сразу в нескольких модулях.
𝟯. 𝗧𝗲𝗺𝗽𝗼𝗿𝗮𝗹 𝗱𝗲𝗰𝗼𝗺𝗽𝗼𝘀𝗶𝘁𝗶𝗼𝗻. Структура кода основана на порядке выполнения операций, а не на сокрытии информации.
𝟰. 𝗢𝘃𝗲𝗿𝗲𝘅𝗽𝗼𝘀𝘂𝗿𝗲. API заставляет вызывающих абонентов знать о редко используемых функциях, чтобы использовать часто используемые функции
𝟱. 𝗣𝗮𝘀𝘀-𝘁𝗵𝗿𝗼𝘂𝗴𝗵 𝗺𝗲𝘁𝗵𝗼𝗱. Метод почти ничего не делает, кроме передачи своих аргументов другому методу с похожей сигнатурой
𝟲. 𝗥𝗲𝗽𝗲𝘁𝗶𝘁𝗶𝗼𝗻. Нетривиальный фрагмент кода повторяется снова и снова
𝟳. 𝗦𝗽𝗲𝗰𝗶𝗮𝗹-𝗴𝗲𝗻𝗲𝗿𝗮𝗹 𝗺𝗶𝘅𝘁𝘂𝗿𝗲. Cпециализированный код не отделен четко от кода общего назначения
𝟴. 𝗖𝗼𝗻𝗷𝗼𝗶𝗻𝗲𝗱 𝗺𝗲𝘁𝗵𝗼𝗱𝘀. Два метода настолько сильно зависят друг от друга, что понимание реализации одного требует понимания другого.
𝟵. 𝗖𝗼𝗺𝗺𝗲𝗻𝘁 𝗿𝗲𝗽𝗲𝗮𝘁𝘀 𝗰𝗼𝗱𝗲. Вся информация комментария очевидна из непосредственно следующего за ним исходного кода.
𝟭𝟬. 𝗜𝗺𝗽𝗹𝗲𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗱𝗼𝗰𝘂𝗺𝗲𝗻𝘁𝗮𝘁𝗶𝗼𝗻 𝗰𝗼𝗻𝘁𝗮𝗺𝗶𝗻𝗮𝘁𝗲𝘀 𝗶𝗻𝘁𝗲𝗿𝗳𝗮𝗰𝗲. Комментарий к интерфейсу описывает детали реализации, которые не нужны пользователям документируемого кода.
𝟭𝟭. 𝗩𝗮𝗴𝘂𝗲 𝗻𝗮𝗺𝗲. Название переменной или метода настолько неопределённое, что практически не несёт полезной информации
𝟭𝟮. 𝗛𝗮𝗿𝗱 𝘁𝗼 𝗽𝗶𝗰𝗸 𝗮 𝗻𝗮𝗺𝗲. Нелегко придумать точное и интуитивно понятное название для сущности
𝟭𝟯. 𝗛𝗮𝗿𝗱 𝘁𝗼 𝗱𝗲𝘀𝗰𝗿𝗶𝗯𝗲. Для полноты документация по переменной или методу должна быть расширена.
𝟭𝟰. 𝗡𝗼𝗻𝗼𝗯𝘃𝗶𝗼𝘂𝘀 𝗰𝗼𝗱𝗲. Поведение или смысл фрагмента кода невозможно понять.
Post #1719
2.15K
- ❤ 23
- 👍 9
- 🤮 6
- 🤔 2