Чи є хорошою практикою використання автоматичного форматування тексту?


11

Я використовую Eclipse, і я розповім про це як приклад, але впевнений, що це стосується будь-якого іншого IDE.

Eclipse має команду CTRL- Shift-, Fяка автоматично форматує ваш код. Чи є хорошою практикою використання такого форматування? Я запитую в контексті великого проекту, в якому може бути багато програмістів, які працюють над одними і тими ж файлами, і все це адмініструється системою CSV.

Дякую!

Відповіді:


12

Так.

Eclipse дозволяє визначити власний стиль коду для експорту, яким ви можете поділитися між усіма своїми розробниками. Якщо ви не хочете налаштувати свій власний стиль форматування, ви можете сказати своїм розробникам використовувати форматування Eclipse за замовчуванням. Навіть якщо ви використовуєте типовий, я б радив експортувати його та розмістити на спільному мережевому диску для всіх розробників. Якщо пізніше ви вирішите змінити одне, ви зможете легко.

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

Крім того, і я ставлю це наприкінці, тому що це лише моя особиста думка, але розглянути питання про видалення 80 символів на рядок (або поширити його на щось більше, у нас тут є 120 символів), тобто якщо я не помиляюся автоматичне форматування довжини рядка на Eclipse за замовчуванням. Зараз у нас всі великі екрани та роздільна здатність екрана, так що це нормально. З цього приводу ознайомтеся з тим, чи є 80-символьним обмеження все ще актуальним під час запитань та відповідей широкоекранних моніторів , то ви, можливо, зможете самостійно прийняти рішення.

Редагувати: Thorbjørn вказує на функцію "Форматування кожного разу, коли файл зберігається".


5

Так, це дуже хороша практика. Це гарантує, що всі згодні з тим, як повинні виглядати вихідні файли під час відкриття в редакторі.

Крім того, у мене був дуже хороший досвід роботи з функцією "Форматування кожного разу, коли файл зберігається". (Ми використовуємо стандартну конфігурацію форматора Eclipse).

Увімкніть це, відкривши властивості Eclipse та виберіть Java -> Редактор -> Зберегти дії. Увімкніть "Виконувати вибрані дії при збереженні" та "Форматувати вихідний код".

Причина, природно, у тому, що код завжди форматується, тому ви можете форматувати за бажанням під час редагування, не боячись, що щось перерветься. Це також забезпечує точність журналів сховищ джерела (що важливо при проведенні криміналістичного аналізу).


Забув про це, хороший момент.
Джалайн

3

У вас повинен бути стандарт кодування, якого ви всі дотримуєтесь. Незалежно від того, чи це застосовується за допомогою зовнішніх інструментів (наприклад, відступ) чи IDE, або вручну, це не має значення. Важливим є те, що це слід зробити будь-яке перед вчиненням.


3

Це найкраща практика дотримуватися чітко визначеного стандарту кодування в проекті / компанії. Засоби цього, хоча можуть бути різними, просто виберіть те, що найкраще підходить для вашої організації. Якщо всі використовують Eclipse, тоді ви можете просто створити формат коду, який можна експортувати, для своїх проектів і розповсюдити його між розробниками (Eclipse також має можливість автоматично форматувати файли при кожному збереженні), проте я рекомендую створити документ, що описує обраний формат.

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.