Java Код: правила оформления и стилизации кода от Skillbox Media

Содержание:

• Причины важности соблюдения единого стиля кодирования
• Автоматическое форматирование кода в интегрированной среде разработки

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

Причины важности соблюдения единого стиля кодирования

Java Code Style представляет собой свод принципов и соглашений, касающихся оформления кода. К примеру:

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

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

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

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

  1. Круглые скобки ( ) чаще всего служат для добавления комментариев, поясняющих деталей, которые не являются основными, но могут дополнить информацию. Например: «Париж (столица Франции) — это город с богатой историей». Также они используются в математике для задания порядка выполнения операций.

  2. Квадратные скобки [ ] применяются для указания на вставки в цитатах, а также в случаях, когда нужно уточнить информацию. Например: «Как отмечает автор [в книге], это событие имеет большое значение». Они могут также использоваться в научных и технических текстах для обозначения изменений или добавлений в оригинальный текст.

  3. Фигурные скобки { } реже встречаются в обычной письменности, но находят широкое применение в программировании и математике, где служат для группировки элементов или определения области действия переменных.

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

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

  Для классов часто используется стиль «CamelCase», при котором каждое слово начинается с заглавной буквы, что помогает выделить название класса среди других элементов. Например, можно использовать такие названия, как `UserAccount` или `OrderProcessor`.

  Переменные обычно именуют в стиле «camelCase», когда первое слово начинается с маленькой буквы, а каждое последующее — с заглавной. Это позволяет быстро понять, что речь идет о переменной. Примеры включают `userName` или `totalAmount`.

  Что касается констант, то для их наименования принято использовать «UPPER_SNAKE_CASE». В этом стиле все буквы заглавные, а слова разделяются символом подчеркивания, что делает константы легко узнаваемыми. Примеры: `MAX_CONNECTIONS` и `DEFAULT_TIMEOUT`.

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

• Оптимальная длина строки кода является важным аспектом при написании программного обеспечения. Обычно рекомендуется, чтобы длина строки не превышала 80-120 символов. Это связано с тем, что более длинные строки могут усложнять чтение и понимание кода, особенно при использовании небольших экранов или в условиях, когда требуется сравнение нескольких строк. Кроме того, соблюдение таких ограничений способствует лучшему форматированию и организации кода, что в свою очередь облегчает его сопровождение и модификацию в будущем.

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

Обоснования, по которым программисты приняли такие договоренности, являются ясными и очевидными:

• При разработке программного обеспечения на поддержку и дальнейшее развитие кода уходит от 70 до 80% всех затрат.
• Работа над кодом, как правило, осуществляется группами программистов, а не отдельными специалистами. Состав этих команд может меняться со временем, и наличие единого стиля кодирования способствует более простому введению новых разработчиков в проект.
• Чтение кода происходит гораздо чаще, чем его написание. Прежде чем осуществить даже незначительное изменение, которое может заключаться всего в нескольких новых строках, необходимо проанализировать сотни, а порой и тысячи строк уже существующего кода.
• Корректное оформление кода способствует более легкому восприятию. Даже если над созданием программы работают различные команды, она останется понятной для любого разработчика, что обеспечит быстрое понимание.
• Поддержка программного обеспечения и сравнение различных версий кода значительно упрощаются, когда файлы оформлены в едином стиле.

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

Автоматическое форматирование кода в интегрированной среде разработки

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

Чтобы отформатировать определённый пакет или весь проект в IntelliJ IDEA, сначала выберите нужный пакет в дереве проекта. Затем выполните команду Reformat с помощью сочетания клавиш. Также можно кликнуть правой кнопкой мыши по выбранному пакету и выбрать опцию Reformat Code. В появившемся диалоговом окне будет предложено не только произвести форматирование, но и оптимизировать импорты — удалить ненужные и упорядочить имеющиеся в соответствии с установленными правилами оформления кода. Рекомендуется активировать этот параметр и затем нажать кнопку ОК.

Итог работы команды по автоформатированию:

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

Некорректно: класс Btn, целочисленный lstId, класс CurPage, строка lName.

Правильные записи: класс Button, переменная int lastId, класс CurrentPage, строка lastName.

Представляйте сокращения в их полном виде. Это делает текст более легким для восприятия, особенно когда название включает несколько слов.

Ошибочно: класс HTMLPage, целое число userID, класс HTTPRequest, строка URL, класс XML.

✅ Верно: класс HtmlPage, целое число userId, класс HttpRequest, строка url, класс Xml

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