Правила форматирования кода в Java (часть 5.1)

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

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

Да, так и есть, код написан с использованием правил форматирования, которые в процессе изучения Java вам необходимо будет освоить. Со временем и при должной практике вы их запомните. Они чем-то похожи на правила оформления текста в книге или статье.

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

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

Давайте рассмотрим некоторые из правил оформления кода, которые были использованы при реализации класса MyFirstApp:

1) между ключевыми (зарезервированными языком Java) словами ставится один пробел, например, static void. Вам никогда не придется ставить два или более пробелов. И написать слитно, например, publicstatic по понятным причинам мы не можем, получится абракадабра, которая не заработает

2) между именем класса и фигурной скобкой нужен пробел: MyFirstApp {.

Это правило относится ко всем открывающимся фигурным скобкам, где бы они не стояли. А вот такой вариант уже выглядит небрежно: MyFirstApp{

3) метод main() размещается внутри класса MyFirstApp, что говорит о его вложенности, которую необходимо визуально отображать. Для этого требуется сдвинуть метод целиком вправо на 4 пробела или один Tab

4) код внутри метода, в свою очередь, вложен и в класс, и в метод main(). Значит, его нужно сдвинуть вправо на 4 пробела дважды: относительно начала класса и начала метода. Итого получается 8 пробелов от левого края редактора или два Tab

5) между именем метода и круглой скобкой пробел не ставится: main(). А такой вариант будет уже неверным: main ()

6) фигурная скобка } должна размещаться строго под началом конструкции, к которой она принадлежит: не правее и не левее

Чтобы на первых порах вам было проще видеть, какой размер отступа используется в коде, ранее мы настроили Sublime Text на отображение пробелов в виде точек.

Чтобы было еще понятнее, начертим стрелки, показывающие направление сдвига кода относительно начала блока (вертикальных линий, которые отображает редактор).

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

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

Программа запустилась без каких-либо ошибок.

Можно записать весь код хоть в одну строку, но его никто не поймет. Многие начинающие разработчики не обращают внимание на внешний вид своего кода. Их цель — написать программу. Но есть хорошее выражение:

Запомнить сразу все правила, которые используются для форматирования кода — не так просто. Для облегчения этого процесса используются статические анализаторы, проверяющие код на несоответствие установленным стандартам. Настройка (обязательная!) одной из таких утилит описана в другой статье.

В этом разделе собрано большое количество правил оформления кода, которые вы можете применять при написании своих программ на Java. Ранее мы уже публиковали (1, 2, 3) похожие правила от компании Google, но их отличие от представленных в этой статье в том, что они не такие детальные и подробные. Правила из этой статьи больше рассчитаны для начинающих программистов: они описывают каждую мелочь, каждую типичную ситуацию.

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

Не пренебрегайте предлагаемыми техниками (изучайте их), способствующими повысить качество, а значит и поддерживаемость вашего кода!

1) Перед и после операторов =, +, -, /, *, %, ==, !=, <, <=, >, >= требуется пробел

неправильно:

правильно:

2) Между ){ скобками требуется пробел

неправильно:

правильно:

3) После ( и перед ) скобками пробел не требуется

неправильно:

правильно:

4) Код, вложенный в класс, метод, цикл и другие блочные конструкции, которые имеют явные или опущенные { }, необходимо сдвигать вправо на 4 пробела (один Tab) относительно начала этой конструкции

неправильно:

правильно:

5) При переносе строки каждую следующую ее подстроку необходимо смещать вправо на 8 пробелов относительно первой строки. При этом перенос следует выполнять (где это возможно) исходя из целостности и связанности переносимой информации, а не по остаточному признаку (что не влезает, то и переносим) — старайтесь, чтобы на каждой строке было примерно равное количество аргументов

неправильно:

правильно:

6) Для переноса курсора на новую строку, вместо System.out.println(); используйте \n (где это возможно) — это уменьшит количество строк кода

избыточно:

предпочтительней:

Если требуется больше переносов, то используйте нужное количество \n

7) В некоторых случаях использование \n неуместно. Вместо этого следует применить System.out.println()

8) Если управляющий символ \n размещается в конце выводимого сообщения, а перед ним идет строка, то совмещайте его с данной строкой, а не конкатенируйте

9) Размещайте комментарии над комментируемым кодом, а не справа от него. Комментарий должен начинаться с той же позиции, что и код. При этом перед комментарием необходима пустая строка (кроме комментария, который идет сразу после объявления метода). Между // и текстом комментария используйте только один пробел

неправильно:

правильно:

10) Отдавайте предпочтение использованию сокращенной формы записи для арифметических операций

избыточно:

правильно:

1) Давайте переменным осмысленные и#nbsp ;понятные имена, глядя на#nbsp ;которые, любому читающему код было#nbsp ;бы ясно, какие значения они хранят. Они должны быть не слишком длинными, но ёмкими. Обычно имена из одной буквы — запрещены

неправильно:

правильно:

2) Объявляйте переменные максимально близко к месту их первого использования, чтобы сузить область их видимости. Не группируйте их в начале метода

3) В одной строке объявляйте не более одной переменной

неправильно:

правильно:

4) Имя переменной не должно быть глаголом или содержать глагол

неправильно:

правильно:

5) Именуйте переменные, используя только английский язык

неправильно:

правильно:

6) Имена переменных начинайте с маленькой буквы

неправильно:

правильно:

7) Перед переменной при приведении типа требуется пробел

неправильно:

правильно:

8) При наличии аббревиатур в именах переменных, прописные буквы — не используются. Применяется обычный camelCase, если аббревиатура является частью многословного имени

неправильно:

правильно:

9) При использовании сокращенной формы инкремента и декремента, после имени переменной пробел не ставится

неправильно:

правильно:

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

неправильно:

правильно:

11) В именах переменных (не констант), состоящих из двух и более слов, нижнее подчеркивание _ не используется. Вместо него применяется стиль camelCase. Это способ именования переменных, когда все слова пишутся слитно, при этом каждое из них начинается с прописной буквы

неправильно:

правильно:

12) Инициализируйте переменные (если это возможно) в строке их объявления, а не где-то ниже в коде

неправильно:

правильно:

13) Не придумывайте свои сокращения для переменных. Нельзя просто взять и сократить имя так, как хочется. Высока вероятность, что программисту, читающему ваш код, их назначение будет непонятно. Кроме того, в больших программах возникнет сложность с поиском нужных переменных, т. к. никто не будет помнить, как именно были сокращены их имена. Можно использовать (и то аккуратно) только распространенные сокращения: tmp, num, nums, src, dest, hh, mm, ss, len и т. д.

неправильно:

правильно:

14) В рамках одной программы не используйте одновременно синонимы, сокращения и полные слова для именования переменных, которые хранят одни и те же по смыслу значения. Нельзя в одной строке написать имя целиком, где-то ниже полностью, а в другом классе использовать синоним. Все имена нужно именовать в одном стиле, используя одни и те же слова

неправильно:

правильно:

15) Не используйте при именовании переменных абстрактные слова (без реальной необходимости), которые ничего не означают, например, value, var и т. д. Если переменная хранит число, то именуйте ее number, num или даже a, b, c — если это какие-то математические вычисления (однобуквенные имена допустимы только для локальных переменных. Но и в этом случае нужно сто раз подумать). Но даже в этом случае следует все взвесить, т. к. числа имеют разное назначение и свой смысл. При именовании переменных задавайте себе вопрос: выбранные имена максимально точно отражают хранимые данные?

неправильно:

правильно:

16) Имена boolean-переменных должны быть прилагательными. Либо они должны начинаться с префикса is/has/can (что больше подходит по смыслу). Префикс are — не используется. При использовании второго способа именования, после префикса должно идти прилагательное. Если прилагательного нет, то после префикса может идти существительное

неправильно:

правильно:

1) Между if и ( необходим пробел

допустимо:

предпочтительно:

2) Даже если тело if-else состоит из#nbsp ;одного выражения, всегда используйте { }. Это поможет избежать трудноуловимых багов. В качестве исключения допустимо использовать однострочники без фигурных скобок, когда имеется очень короткое выражение

неправильно:

правильно:

допустимо:

3) Слово else и else-if оставляйте на той же строке, что и }, отделив их друг от друга пробелом

неправильно:

правильно:

4) Не отделяйте if от else новой строкой (где это возможно)

плохо (зачем тратить лишнюю строку под if):

правильно:

5) Не оставляйте новый блок с if на одной строке с предыдущим if. Переносите его на следующую строку

неправильно:

правильно:

6) При проверке boolean-значений не указывайте явно true или false

избыточно:

правильно:

1) Между for и (, между while и ( требуется пробел

допустимо:

предпочтительно:

2) do-while оставляйте на той же строке, что и }, отделив их друг от друга пробелом

неправильно:

правильно:

3) Стандартное именование счетчиков в цикле for — это i, j, k. Последние два используются для вложенных циклов

неправильно:

правильно:

4) Имена переменных i, j, k допустимо использовать в качестве счетчика только для for. Для других циклов придумывайте более осмысленные имена

неправильно:

правильно:

5) В рамках одного метода, при использовании не вложенных циклов, не меняйте имена счетчиков

неправильно:

правильно:

6) Если тело цикла состоит из одного выражения, всегда используйте { }. Это поможет избежать трудноуловимых багов

неправильно:

правильно:

7) При проверке boolean-значений не указывайте явно true или false

избыточно:

правильно:

Автор: Чимаев Максим

Контакты:

#java #разработка #it #программирование #startjava #topjava