Java - Философия разработки - Качественный код – слагаемые

Java - статьи
Оглавление
Java - Философия разработки - Качественный код – слагаемые
Соглашения кода (code conventions)
Обработка исключений
Документирование
Легкая читаемость кода
Все страницы

Для начала я вообще хочу определить, о чем пойдет речь. Ибо качество кода многие неразрывно отождествляют с качеством приложения – устойчивостью, скоростью, безопасностью и т.п. Я хочу поговорить несколько о другом – о качестве именно программного кода. Это не одно и то же. К сожалению, есть много примеров быстрых, устойчивых приложений, качество кода в которых оставляет желать лучшего. И наоборот – код может быть очень качественным, а приложение никуда не годится. И если качество приложения в основном зависит от продуманности его архитектуры, то качество кода зависит непосредственно от разработчиков.

Итак, что есть качественный код? С позиции менеджера по качеству кода я могу дать следующее определение:

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

Как правило, код необходимо поддерживать. Очень редки ситуации, когда код написали и забыли. И затраты на поддержку, как показывает практика, зачастую серьезно превышают затраты на разработку. Как я уже упоминал во , код пишут разные разработчики, каждый со своим стилем, видением мира и квалификацией. И в этих условиях важнейшую роль играют правила, при соблюдении которых вероятность получить хорошо приспособленный к поддержке код сильно повышается. Разумеется, если есть цель запутать код как только возможно – не спасут никакие правила. Если же такой цели нет – следование этим правилам может серьезно облегчить жизнь.

Основных правил создания качественного кода, на мой взгляд, четыре. Возможно, их больше, эти же я считаю необходимым минимумом. Итак, код на пути к качественному, если (в порядке убывания значимости):

Остановимся на каждом из правил подробнее.

... он следует принятым соглашениям

... присутствует обработка исключительных ситуаций

... он документирован

... он легко читается


 

Добавить комментарий


Защитный код
Обновить

Меню