Как изменить шаблон Javadocs, созданный в Eclipse?


124

Мне не нравятся Javadocs по умолчанию, сгенерированные для меня, когда я создаю класс или методы, особенно переменную @author, которая является текущим системным именем пользователя в моем окне Windows.

Я хотел бы это изменить. Это возможно?


2
Для @authorнастройки переменной вы можете настроить свою пользовательскую строку, отредактировав eclipse.iniдобавление файла -Duser.name=customstring(протестировано в Kepler / Luna )
KrishPrabakar

3
Лучше избавьтесь от @authorметки, так как это нежелательный шум .
Александр Позднеев

Ответы:


189

Проверьте Preferences / Java / Code Style / Code Template

Раздел Comment / Type

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

Шаблоны кода


Однако, если шаблон в порядке, но значение, указанное в теге автора, не указано, см. Этот вопрос SO :

${user}использует значение user.nameпеременной окружения; Таким образом, вы можете передать -Duser.name=My Nameв eclipse.iniпереназначить его.

Или, если хотите, вы можете изменить ярлык, указав на:

C:/java/eclipse/eclipse.exe -vmargs -Duser.name="cleverUserNameToUseInSourceCode"

  • MacOs: Арам Кочарян упоминаетeclipse.ini вEclipse.app/Contents/MacOS/ , если вы щелкните правой кнопкой мыши и перейдите Показать Содержание пакета.
  • ZendStudio: rofflox комментирует файл с именем ZendStudio.iniи именем Applications/Zend Studio.app/Contents/MacOS/.

5
Несвязанный: Как вы сделали такой красивый снимок экрана?
Пол Ламмертсма

1
@Paul: после того, как этот мем оказался "обязательным" ( meta.stackexchange.com/questions/19478/the-many-memes-of-meta/… ), мне пришлось использовать FSCapture ( faststone.org/FSCaptureDetail.htm ) соблюдать;)
VonC

Snipping Tool отлично справляется с Win7. Спасибо за скриншот. Это как раз то, что мне было нужно сегодня вечером! :)
Joseph Lust

1
Для пользователей Mac eclipse.ini находится в Eclipse.app/Contents/MacOS/, если щелкнуть правой кнопкой мыши и перейти «Показать содержимое пакета»
Арам Кочарян,

То же самое и с Zend Studio для Mac. ZendStudio.iniНаходится в Applications/Zend Studio.app/Contents/MacOS/.
rofflox

6

Посмотрите Окно -> Настройки -> Java -> Редактор -> Шаблоны.


Да, я знаю об этом, но, к сожалению, это никак не влияет на генерацию кода для классов. Я не хочу делать это вручную
Оласени

3

Spring Tool Suite (популярная настройка Eclipse для разработки Spring) использует STS.ini. В Windows я нашел его в том же каталоге, что и исполняемый файл для запуска приложения.


Для STS в Mac OS см. Ответ VonC при поиске в пакете приложения STS.
Kent Bull

3

Чтобы использовать имя пользователя и адрес электронной почты Git, вы можете использовать переменные ${name:git_config(user.name)}и ${email:git_config(user.email)}.

введите описание изображения здесь


Это находится подPreferences / Java / Code Style / Code Templates / Comments / Types
timbru31

1

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


Есть ли способ заменить создание eclipse javadoc eclipse на JAutoDoc? Я имею в виду: я установил плагин JAutoDoc. Если я сейчас сгенерирую методы get / setter с помощью Shft + Alt + S и выберу «Generate Getters and Setters ...», комментарии javadoc все равно будут генерироваться eclipse. Но я хочу генерировать эти комментарии JAutoDoc автоматически ...
Штеффен
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.