Это хорошая практика, чтобы использовать автоформатирование текста?

11

Я использую Eclipse, и я буду говорить об этом в качестве примера, но я уверен, что это имеет место в любой другой IDE.

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

Спасибо!

Йонут
источник

Ответы:

12

Да, это.

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

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

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

Изменить: Thorbjørn делает хорошее замечание о функциональности «Форматировать каждый раз, когда файл сохраняется».

Jalayn
источник
5

Да, это очень хорошая практика. Это гарантирует, что все согласны с тем, как должны выглядеть исходные файлы при открытии в редакторе.

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

Включите его, открыв свойства Eclipse, и выберите Java -> Редактор -> Сохранить действия. Включите «Выполнять выбранные действия при сохранении» и «Форматировать исходный код».

Естественно, причина в том, что код всегда отформатирован, поэтому вы можете форматировать по желанию при редактировании, не опасаясь, что что-то сломается. Это также гарантирует, что журналы исходного хранилища являются точными (что важно при проведении судебного анализа).


источник
Забыл об этом, хорошая мысль.
Джалайн
3

У вас должен быть стандарт кодирования, которому вы все следуете. Применяется ли это внешними инструментами (такими как отступ), или IDE, или вручную - не имеет значения. Что важно, так это то, что это должно быть сделано перед фиксацией.

Сардатрион - против злоупотребления SE
источник
3

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

devmiles.com
источник