2.15. Качество кода

Внутреннее качество начинается с качества исходного кода программы. Качество кода определяется качеством идей, изложенных в этом коде. Основным фактором качества исходного кода программы является его читаемость и понятность.

Код может читать любой разработчик из организации с любой целью:

  • выяснить, почему снаружи все так плохо или хорошо выглядит;
  • понять, не реализовано ли то, что может пригодиться коллеге.

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

Правила форматирования кода должны быть едиными во всем проекте. А лучше — во всей организации и во всем мире, потому что разработчики часто читают исходный код других проектов. Вспомним еще раз про единство дизайна. Это одно из его проявлений.

Весь новый код необходимо писать в соответствии с принятыми стандартами кодирования для Java. Многие среды разработки (например, Eclipse и IntelliJ IDEA) могут автоматически форматировать код. Это может помочь при включении чужого или старого кода в проект, но новый код необходимо создавать сразу правильно.

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