Вредные советы для Java разработчиков

Наименование

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

Например, вот так:

Читаемо, понятно… Фу, как скучно и неинтересно. Да и ещё комментарии вставить некуда и незачем. Никакой интриги, давайте сэкономим ресурсы нашей клавиатуры и уберем эти длинные названия.

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

Вопрос для самопроверки: Какой шаблон GoF тут использован?

Порядок полей/методов в классах

Если почитать всяких высоколобых заучек, то порядок следования полей и методов в классе имеет смысл. Они высокомерно считают, что это почему-то полезно. Например, предлагают следующие вариант порядка: поля, конструкторы, публичные, приватные методы.

Примерно вот так:

Всё читаемо, порядок следования предсказуемый. Требуются усилия чтобы выдерживать его, перемещать код после автогенерации в нашей любимой IDE. Боже, как скучно. Да и зачем, и без этого можно найти то, что надо. В IDE для этого есть необходимый функционал. Пускай, она не всегда доступна, но это не наша проблема. Будем делать так, как хотим и как сейчас удобно:

Теперь удобно, не отвлекаемся на всякие там порядки и перемещения кода. Если кому-то что-то непонятно, то можно сдобрить наш код комментариями. Обилие комментариев в коде ­– это так прекрасно.

Раз уж мы заговорили про комментарии, то давайте к ним и перейдем.

Комментирование кода

Есть мнение, что хорошему коду комментарии не нужны. Он самодокументируемый, мол читается с ходу, понятен и так. Подробные комментарии нужны для описания API классов, библиотечных функций. В реализации они, скорее, признак проблем с кодом.

Но это высоколобые самоутверждаются и пишут подобный код:

Давайте наполним комментариями: мы добавим много строчек в наш код, объясним его для всех. И все станет сразу красиво и многословно:

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

Форматирование

Мы часто слышим про форматирование, некоторые даже вносят его в Code Convention.

Но зачем там это? Код становится длинным по вертикали, приходится скролить его вверх-вниз. У нас же широкий экран, пусть остальные такой же покупают. Табуляция, пробелы… Больно много клавиш там надо нажимать. Да и ещё эти вечные войны, что лучше – табуляции или пробелы, различные подобные халивары. Давайте просто писать много длинного кода:

Как много текста, пустого, сплошные пробелы… Зачем? Пишем быстро, красиво и компактно:

Вот так прекрасно, компактно, лаконично, быстро.

Заключение

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

Хотелось бы добавить, что в открытых источниках сейчас можно найти массу бесплатного материала о том, как писать код на Java. Но никто вам не гарантирует, что в результате получится чистый и правильный код. На курсе "Java Developer. Professional" от Отус мы как раз учим писать корректно и эффективно, обратная связь от наших экспертов приближена к code review на рабочих проектах.

Курс рассчитан на разработчиков с опытом. Проверить свои знания и пройти тест можно по ссылке: Java Developer Professional