Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-02-21

1 <a>#База знаний</a>

2 <ul><li>10 дек 2020</li>

3 <li>0</li>

4 </ul>Статья об именах переменных, классов и методов, скобках, комментариях, форматировании кода и других правилах хорошего тона, принятых в языке Javа.

5 vlada_maestro / shutterstock

6 Преподаватель Skillbox. Пишет про Java, учит Go. Помнит рассвет PHP и как "грабить корованы".

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

8 Java Code Style - это рекомендации и соглашения о стиле кода, собранные вместе. Например:

9 <ul><li>как использовать отступы;</li>

10 <li>когда и как ставить скобки всех видов;</li>

11 <li>как оформлять комментарии;</li>

12 <li>в каком стиле давать названия классам, переменным, константам;</li>

13 <li>какой должна быть максимальная длина строки кода.</li>

14 </ul>Регламентируется множество вещей, связанных с оформлением исходного текста программ, и приводятся требования, которые необходимо учитывать. Почему возникли эти стандарты?

15 Причины, по которым разработчики пришли к таким соглашениям, логичны и просты:

16 <ul><li>70 - 80% расходов при создании ПО приходится на поддержку и развитие кода.</li>

17 <li>Над кодом обычно работают команды программистов, а не один человек. Состав команд меняется со временем, и единый стиль позволяет легче вводить новых разработчиков в проект.</li>

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

19 <li>Правильное оформление кода облегчает чтение. Даже если текст программы пишут разные команды, он будет понятен каждому разработчику, а скорость восприятия будет высокой.</li>

20 <li>Гораздо проще поддерживать программы и сравнивать версии кода, когда у файлов согласованный стиль.</li>

21 </ul>Использование общепринятых соглашений по оформлению позволяет сделать код более аккуратным, избежать ошибок, связанных с разными стилями написания у людей, работающих над одним проектом.

22 Стиль не играет роли для компьютера, но важен для чтения кода человеком. Наше зрение устроено так, что сперва получает и анализирует образы, а только затем мы вдаёмся в детали. А если блоки исходного текста унифицированы, разработчик понимает, что перед ним за конструкция, даже не вникая в сам код.

23 Видя такую конструкцию, программист сразу же понимает, что это if … else. Он прочитает это мгновенно и пойдёт изучать код дальше. А если глазу попадается что-то отличающееся от привычного, чтение сразу переходит в медленный побуквенный режим. Вот здесь, например, потребуется детально изучить код, чтобы понять его смысл:

24 Если стиль форматирования меняется от конструкции к конструкции, это затрудняет считывание паттернов - мы спотыкаемся глазом на каждой нестандартно написанной строчке.

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

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

27 JetBrains IntelliJ IDEAEclipse IDEWindows\LinuxCtrl + Alt + LCtrl + Shift + FMacOs⌘ + ⌥ + L⌘ + Shift + FФорматирование пакета или всего проекта в IntelliJ IDEA

28 Выберите в дереве проекта нужный пакет и вызовитеReformat, используя горячие клавиши. Как вариант, можно нажать по пакету правой кнопкой мыши и выбратьReformat Code. Откроется диалоговое окно, в котором, кроме форматирования, будет предложено оптимизировать импорты (удалить лишние и привести в порядок существующие в соответствии с Code Style). Рекомендуется отметить этот пункт и нажать ОК.

29 Результат выполнения команды автоформатирования:

30 Соглашения по стилю кода Java различны, а, кроме того, разработчики могут использовать свои модификации. Чтобы у всей команды был один стиль кода, его можно задать в среде разработке.

31 Один из популярных наборов правил по оформлению кода для Java написала компания Google. Он называется Google Java Style Guide и <a>доступен на GitHub</a>. Вы можете без труда установить его в любимую IDE, с которой работаете. Для примера рассмотрим, как это сделать в среде разработки JetBrains IntelliJ IDEA:

32 <ul><li>Скачайте файл<a>intellij-java-google-style.xml</a>c правилами форматирования с GitHub.</li>

33 <li>Откройте IntelliJ IDEA, зайдите в настройкиFile → Settings… (Ctrl + Alt + S)и выберите загрузку файла в пункте Scheme, как на скриншоте:</li>

34 </ul><ul><li>В диалоговом меню выберите скачанный файл и в полеSchemeвыберитеGoogleStyle.Затемсохраните изменения, нажавApply/OK.</li>

35 </ul>Теперь при форматировании будут использоваться правила Java Google Style.

36 Используйте автоформатирование после окончания работы над блоком кода и перед отправкой кода в удалённый репозиторий. Да пребудет ваш код чистым и красивым!

37 Теперь разберём основные правила, которые есть в Code Style, и как их использовать в ваших рабочих проектах.

38 Классы в java располагаются в отдельных файлах расширения.java, и название файла строго должно соответствовать имени класса, включая регистр.

39 ❗️Неправильно:файл main.java

40 ✅ Правильно:файл называется как класс - Main.java

41 Классы и интерфейсы именуются с большой буквы. Если имя состоит из нескольких слов, то каждое слово также начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называетсяUpperCamelCase.

42 ❗️ Неправильно:phoneBook, full_name, main, result-list

43 ✅ Правильно:PhoneBook, FullName, Main, ResultList

44 Класс принято называть существительным: Car, Bird, ArrayList, Book. Возможно добавлять уточняющее прилагательное ImmutableList.

45 Интерфейс, как и класс, может быть существительным: List, Set, Map. А также прилагательным, если указывает на свойство: Readable, Сomparable, Closable.

46 Отдельно стоить отметить классы тестов, к ним принято добавлять слово Test в окончании: HashTest, HashIntegrationTest

47 Методы именуются со строчной (маленькой) буквы; если имя состоит из нескольких слов, то каждое последующее слово начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называетсяlowerCamelCase.

48 ❗️ Неправильно:Print(), get-Size(), Main(), is_hidden()

49 ✅ Правильно:print(), getSize(), main (), isHidden()

50 Методы - это действия, поэтому их принято называть глаголами: sendMessage (), stop (), parse (), add ()

51 Отдельно можно отменить геттеры и сеттеры. Название метода геттера формируется из названия переменной и префикса get. Если переменная length, то геттер: getLength (). Если переменная типа boolean и названа isAlive, то геттер будет также называться isAlive (), являясь ответом на вопрос в названии метода.

52 Сеттеры формируются по такому же принципу, но с префиксом set. Продолжая примеры выше: для length сеттер будет setLength (). Для переменной типа boolean isAlive, сеттер будет без приставки setAlive ().

53 Переменные именуются со строчной (маленькой) буквы; если имя состоит из нескольких слов, то каждое последующее слово начинается с большой буквы. Подчёркивания, тире не используются. Такой стиль нейминга называетсяlowerCamelCase.

54 Имена переменных в общем случае - это существительные либо составные существительные с добавлением прилагательных.

55 ❗️ Неправильно:PostService, e_mail, post-id, _email

56 ✅ Правильно:postService, email, postId, isAlive

57 Данные правила относятся к локальным переменным (внутри методов), параметрам класса, а также к не статическим константам.

58 Константы именуются в стилеSNAKE_CASE, то есть слова разделены нижним подчёркиванием и все буквы прописные (большие)

59 Константами считаются static final поля, но не все. Поле должно быть примитивом, String или иммутабельным классом. То есть параметры класса константы не должны иметь возможности изменяться, а его методы - иметь побочные эффекты, влияющие на другие классы. Элементы Enum тоже являются константами.

60 ✅ Константы:

61 static final int NUMBER = 5; //примитив enum SomeEnum { ENUM_CONSTANT } // enum static final ImmutableList<String> NAMES = ImmutableList.of("Ed", "Ann"); // неизменяемый список, с неизменяемыми элементами String static final ImmutableMap<String, Integer> AGES = ImmutableMap.of("Ed", 35, "Ann", 32); // неизменяемый Map, с неизменяемыми элементами String❗️ Не именуются как константы:

62 static String nonFinal = "non-final"; // не final final String nonStatic = "non-static"; // не статична static final Set<String> mutableCollection = new HashSet<String>(); // мы можем изменять содержимое Set static final ImmutableSet<SomeMutableType> mutableElements = ImmutableSet.of(mutable); // изменить количество элементов в коллекции нет возможности, но менять состояние самих элементов коллекции есть возможность static final String[] nonEmptyArray = {"these", "can", "change"}; // поменять элементы массива возможноКак и у переменных, названия констант - это существительные либо составные существительные с добавлением прилагательных.

63 Для наименования методов, переменных, классов используйте только английский язык. Использование английского - это принятый стандарт, чтобы ваш код был всем понятен. Транслит намного хуже читается, а если кто-то не знаком с русским, он и вовсе не поймёт смысл наименования. Если затрудняетесь в выборе названия, воспользуйтесь гугл-переводчиком. Так, кстати, вы пополните свой словарный запас.

64 ❗️ Неправильно:schet, kolichestvo, soderjitImya, fio

65 ✅ Правильно:account, amount, containsName, fullname

66 Фигурная скобка открывается на той же строке, что и код перед ней.

67 public static void main(String[] args) { System.out.println("Hello, code style!"); }Тело условного оператора или цикла всегда размещайте в {}, даже если это одна строка. Так можно избежать ошибок, если попробуете добавить вторую строчку, но забудете заключить её в фигурные скобки.

68 ❗️ Неправильно:schet, kolichestvo, soderjitImya, fio

69 for (int i = 0; i < 10; i++) System.out.println(i);✅ Правильно:account, amount, containsName, fullname

70 for (int i = 0; i < 10; i++) { System.out.println(i); }Нежелательно при именовании использовать сокращения. Это связано как с пониманием расшифровки, так и с поиском по классам и методам. Коллеги, которые будут читать код, могут не найти их с такими названиями и посчитают, что надо создать заново.

71 ❗️Неправильно:class Btn, int lstId, class CurPage, String lName

72 ✅ Правильно:class Button, int lastId, class CurrentPage, String lastName

73 Аббревиатуры представляйте в виде слов. Это более удобочитаемо, особенно если название состоит из нескольких.

74 ❗️ Неправильно:class HTMLPage, int userID, class HTTPRequest, String URL, class XML

75 ✅ Правильно:class HtmlPage, int userId, class HttpRequest, String url, class Xml

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

77 <a>Бесплатный курс по Python ➞Мини-курс для новичков и для опытных кодеров. 4 крутых проекта в портфолио, живое общение со спикером. Кликните и узнайте, чему можно научиться на курсе. Смотреть программу</a>