Кава-брейк #86. Короткий і простий посібник із переформатування коду в IntelliJ IDEA

Джерело: Lightrun Як розробнику, вам доведеться вносити зміни до кодової бази. І якщо кодова база чітко не відформатована, то налагодження вам помітно ускладниться. Невеликі зміни, такі як переформатування та правильні відступи в коді, зазвичай упускаються з уваги, але вони, очевидно, допомагають відрізнити кодову базу професійного розробника від коду новачка. Збереження правильного формату коду та відступів допоможе написати код, який легше читати. Це спрощує спільну роботу над проектами, збільшує швидкість налагодження та обслуговування кодової бази. Код набуває хорошої читабельності та структури. Чи можна прискорити процес переформатування коду? Ця стаття познайомить вас із простим методом автоматичного переформатування коду за допомогою IntelliJ IDEA. Ви дізнаєтесь, як скоротити час на цю процедуру, а також навчитеся виключати частину кодової бази з переформатування, використовуючи різні комбінації клавіш.

Переваги переформатування

Важливо пам'ятати, що для роботи функції не потрібний код форматування та коментування. Будь-який код з форматуванням або без нього повністю може бути прочитаний і виконаний компілятором. З іншого боку, переформатування значно полегшує читання розмітки. Для компілятора важливим є лише те, що код працює і те, що не містить помилок, а не те, наскільки він хороший або з гарним відступом. Щоправда, людей непокоїть саме останнє, бо їм доводиться читати такий код. Як і у випадку зі звичайним текстом, ніхто не любить читати безформний контент без заголовків, абзаців або будь-яких відступів. Деякі з необхідних методів переформатування включають:

• Відступ.
• Стиль та написання функцій.
• Пустий простір.
• Використання великих літер та найменувань.

Налагодження - неминуче зло, з яким розробник часто стикатиметься протягом своєї кар'єри. З чого почати, якщо ваша кодова база захаращена і дезорганізована? Коли вихідний код правильно відформатовано та має відступ, він виглядає менш кластеризованим. Це полегшує визначення того, де знаходяться різні модулі програми. Отже, спрощується пошук проблем та помилок. Переформатування коду в IntelliJ IDEA ґрунтується на вимогах, зазначених у налаштуваннях стилю коду в IDE. Хоча, коли ви використовуєте EditorConfig у своєму проекті, налаштування, які ви вказали у файлі .editorconfig, за замовчуванням перевизначають ті, які вказані в налаштуваннях стилю коду. Переформатування в IntelliJ не відрізняється від інших IDE. Існують варіанти переформатування окремого блоку коду, так і всього файлу. Можуть бути випадки, коли весь блок коду досить довгий, і ви хочете, щоб все було переформатовано, за винятком декількох конкретних областей. У цьому випадку індивідуальний вибір частин коду, які ви хочете відформатувати, не найкращий варіант. У таких ситуаціях переформатування за допомогою IntelliJ безперечно знадобиться. Ми вивчимо цей та інші варіанти використання IDE.

Поради щодо форматування коду

Давайте розглянемо кілька основних порад щодо форматування коду загалом:

• Переконайтеся, що код правильно прокоментований. Використовуйте коментарі, щоб передати намір та зміст. Навіть якщо ви єдиний, хто читає цей код, це все одно корисно нагадувати призначення тих чи інших блоків коду. Це полегшить роботу, якщо ви повернетеся до своєї кодової бази, наприклад після відпустки.

• Не використовуйте табуляції для пробілів в одному рядку. Це знижує читабельність коду.

• Додайте TODO до своїх блоків коду, щоб стежити за майбутніми реалізаціями. Таким чином, коли ви переформатує свій код, це не створить ілюзію того, що ваша робота завершена.

• Не використовуйте переформатування коду як швидке виправлення синтаксичних помилок.

• Уникайте глибоких вкладень. Це звичайна практика серед деяких розробників, але глибока вкладеність коду ускладнює читання та дає місце помилкам, які нелегко виявити з першого погляду.

Переформатування коду в IntelliJ IDEA

Перш ніж ми досліджуємо різні способи форматування коду IntelliJ, почніть зі створення зразка проекту Java у вашому середовищі IDE. Після запуску IntelliJ ви повинні побачити такий екран: Натисніть Далі та завершіть налаштування ініціалізації проекту. Тепер, коли ваш проект налаштований, настав час додати зразок коду, який допоможе вам зрозуміти переформатування коду IntelliJ. Це простий лічильник слів від Техаського університету:

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.Scanner;
import java.util.TreeMap;

public class SimpleWordCounter {

    public static void main(String[] args) {
        try {
            File f = new File("ciaFactBook2008.txt");
            Scanner sc;
            sc = new Scanner(f);
            // sc.useDelimiter("[^a-zA-Z']+");
            Map<String, Integer> wordCount = new TreeMap<String, Integer>();
            while(sc.hasNext()) {
                String word = sc.next();
                if(!wordCount.containsKey(word))
                    wordCount.put(word, 1);
                else
                    wordCount.put(word, wordCount.get(word) + 1);
            }

            // show results
            for(String word : wordCount.keySet())
                System.out.println(word + " " + wordCount.get(word));
            System.out.println(wordCount.size());
        }
        catch(IOException e) {
            System.out.println("Unable to read from file.");
        }
    }
}

Переформатування фрагментів коду

Почнемо із форматування фрагментів коду. Для цього просто виділіть частину коду, яку потрібно відформатувати, і натисніть Code > Reformat Code . Як ви можете бачити, виділена частина коду (у даному випадку рядки 11–17) відформатована правильно. Давайте подивимося на “до” та “після” переформатування нашого фрагмента коду. Якщо ви помітабо на першому зображенні, оголошення та ініціалізація вашої змінної відбулися в тому ж рядку, що й . Закривають фігурні дужки змішані з блоком else . Але після виділення цієї частини вашого коду та використання опції переформатування у вас вийде приємніший для очей блок коду. Тепер повний код вашого класу виглядає приблизно так: Зверніть увагу, що переформатовано лише обраний вами блок коду.

Переформатування цілих файлів

Щоб переформатувати весь файл, відкрийте редактор, помістіть курсор у будь-яке місце та натисніть Code >Reformat File . Вам буде запропоновано вибрати відповідні параметри переформатування всього файлу. Ця дія переформатує весь код у активному редакторі. Ваш код стане приблизно таким:

Переформатування модуля чи каталогу

Для цього все, що потрібно зробити, це клацнути правою кнопкою миші модуль у вікні інструментів проекту і вибрати Reformat Code . У спливаючому вікні виберіть будь-який із трьох необхідних вам варіантів:

• Оптимізувати імпорт : виберіть цей варіант, якщо ви бажаєте додати відсутні оператори імпорту, а також позбавитися від операцій імпорту, які не використовуються.

• Переупорядкувати записи : для реорганізації коду відповідно до правил розташування, вказаних у налаштуваннях стилю коду.

• Код очищення : для запуску очищення коду.

Коли закінчите, просто натисніть кнопку ОК.

Виняток коду з переформатування

Давайте розглянемо, що робити, якщо у вас є блок коду, який ви не хочете включати під час форматування всього файлу. Перейдіть до File > Settings або скористайтеся поєднанням клавіш Ctrl+Alt+S. Перейдіть в Editor > Code Style і встановіть прапорець Enable formatter markers (Увімкнути маркери форматування) у меню коментарів на вкладці Formatter Control (Керування форматуванням). У своєму редакторі створіть малий коментар та введіть //@formatter:off без лапок на початку області, яку ви хочете виключити. Наприкінці області створіть ще один малий коментар та введіть //@formatter:on також без лапок. На зображенні вище ви можете побачити, що форматування проігнорує ваш код у рядку 23 просто тому, що ви вказали це в коментарях і контролері форматування.

Приклади гарячих клавіш для переформатування

• Переформатувати блок коду: Ctrl+Alt+Shift+L
• Переформатувати файл: Ctrl+Alt+L
• Додати коментар до рядка: Ctrl + /
• Додати коментар блоку: Ctrl + Shift + /

Висновок

Приділяти увагу форматам коду також важливо для розробника, як і змусити його працювати. Ви ніколи не можете сказати, хто зрештою буде працювати з вашим кодом. Наявність легко читається, добре структурованої кодової бази говорить про професійного розробника. Завдяки IntelliJ IDEA форматування коду не повинно бути таким складним, як написання самого коду. Наступного разу, коли писатимете код з використанням IntelliJ, скористайтеся цими порадами. Так ви спростите собі життя під час налагодження коду.