Используйте форматтер кода вашей IDE

Это часть краткой серии статей о хороших привычках для Java-программистов.

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

Какие варианты форматирования следует выбрать?

Автоформаттер вашей IDE зависит от вашего мнения. В вашей IDE он будет настроен с кучей стандартных предпочтений, которые автор посчитал наилучшими. Вы можете изменить их, если хотите, но не беспокойтесь об этом: если вам это нравится (например, вы действительно хотите, чтобы он использовал 5 пробелов вместо 4 для отступов), идите и вносите изменения; но настройки по умолчанию будут очень хороши для того, что вы делаете как начинающий программист. Важно то, что форматтер основан на правилах и будет последовательным, избавляя вас от необходимости решать, каким соглашениям форматирования вы хотите подчиняться, и, что самое важное, от необходимости выявлять нарушения и исправлять их вручную. Вы вряд ли выиграете эту игру, да и кто вообще хочет в нее играть?

Автоформатирование не исправит все

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

        if (isValid) {
            System.out.println("The input is valid");
        } else {
            System.out.println("The input is not valid");
            System.out.println("Please enter another value");

            System.out.println("Thank you");


        }
Войти в полноэкранный режим Выход из полноэкранного режима

Перед System.out.println("Thank you"); есть непоследовательная, лишняя новая строка, которую ваш форматтер, вероятно, не поймает. И после этого утверждения есть лишние новые строки, которые ваш форматтер, скорее всего, не удалит. Так что вам все равно придется немного поработать над собой, но форматер поможет вам в этом. Очень долгий путь.

Итак, как мне это сделать?

  • Eclipse Ctrl+⇧+F на Windows/Linux; ⌘+Shift+F на Mac
  • IntelliJ Ctrl+Alt+L в Windows/Linux; ⌘+⌥+L на Mac
  • Visual Studio Code Это требует некоторой настройки.

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

Оцените статью
devanswers.ru
Добавить комментарий