Please enable JavaScript.
Coggle requires JavaScript to display documents.
Чистый код. Роберт Мартин - Coggle Diagram
Чистый код. Роберт Мартин
Чистый код
Метрика
Единственная надежная метрика качества кода: количество "чертей" в минуту
Правило бойскаута
Оставь место стоянки чище, чем оно было до твоего прихода
Опредение
Это код, который сложно улучшить
Содержательные имена
Имена должны передавать намерения программиста
Избегайте дезинформации
Используйте удобопроизносимые имена
Выбирайте одно слово для каждой концепции
Не добавляйте избыточный контекст
Функции
Правило одной операции
Не должно быть секций в функциях
Один уровень абстракции на одну функцию
Чтение сверху-вниз
Правило понижения
За каждой функцией должны следовать функции следующего уровня абстракции
Использовать содержательные имена
Глаголы и ключевые слова
Аргументы функций
Не более двух аргументов
Объекты как аргументы
Чистые функции
Разделение команд и запросов
При ошибках использовать исключения вместо возврата кода ошибок
DRY
Комментарии
Главные принципы
Объясни свои намерения в коде
Не использовать комментарии там, где можно использовать функцию или переменную
Хорошие комментарии
TODO
Необходимо сделать, но нельзя сделать сейчас
Предложить другим поучаствовать в решении проблемы
JSDoc
Можно/нужно в общедоступном API
Нельзя во внутреннем коде
Не будет генерироваться документация
Плохие комментарии
Избыточные
Комментарии о том, как исполняется код
Недостоверные
Бормотание
Обязательные комментарии в очевидных местах
@param title Заголовок
Шум
Закомментированный код
Слишком много информации
Форматирование
Объекты и структуры данных
Обработка ошибок
Границы
Модульные тесты
1