В IDEA, как сгенерировать javadoc для нового типа?
В Eclipse alt + shift + J нового типа будет генерировать javadoc с указанием автора и даты.
например
/**
* @author eric
* @date Apr 3, 2015 8:49:31 PM
*/
В IDEA я пробовал, но он просто генерирует пустой Javadoc без автора и даты.
например
/**
*
*/
Вопрос в том:
- Как в IDEA создать javadoc так же, как Eclipse, с указанием автора и даты?
- Можно ли сгенерировать его автоматически при создании типа?
- Какой ярлык для этого используется по умолчанию?
@Update - резюме
Согласно комментарию и ответу, в шаблон файла добавляется следующий javadoc:
/**
* @author ${USER}
* @date ${DATE} ${TIME}
*/
для типа файла: Class, Interface, Enum, AnnotationType.
Документация javadoc будет добавлена автоматически при создании типа. Но все же кажется, что нет ярлыка, чтобы добавить его вручную для существующих типов.
Ответы 2
Для классов, интерфейсов и т. д. Вы можете отредактировать Шаблон файла: Preferences | Editor | File and Code Templates.
/**
* @author Eric
* @date ${DATE}
*/
Для методов, которые могут быть сгенерированы (например, геттеров, сеттеров), вы можете использовать следующий ответ: https://stackoverflow.com/a/38094408/3124227
Для методов нет возможности редактировать javadoc: https://youtrack.jetbrains.com/issue/IDEA-97658
Хорошо, я решил это. Кстати, есть больше заполнителей ${USER} для имени пользователя системы, ${DATE} {TIME} для получения даты и времени, и я применяю это к Class, Interface, Enum, AnnotationType, теперь он работает очень похоже, как в Eclipse.
Почему ты хочешь? Именно такую информацию помогает отслеживать система контроля версий! Например, вы можете получить это из Git, запустив git log --diff-filter=A --follow path/to/my/Class.java.
(Спасибо https://stackoverflow.com/a/13598028 за конкретный фрагмент.)
Чтобы быть ясным, я не против Javadoc в целом, я использую его только для ручного отслеживания информации, которая автоматически отслеживается в другом месте.
Проблема в вопросе призвана помочь при просмотре исходного кода, на самом деле не имеет отношения к какой-либо системе контроля версий, это уже другая история.
И, когда вы публикуете код как jar, пользователю не обязательно иметь доступ к scm, как Git, тогда javadoc еще более важен для получения такой информации.
@EricWang Если вы можете дать им дамп исходного кода, вы можете предоставить им доступ SCM. Тем не менее, это в любом случае не особенно полезно для внешнего пользователя. В этом случае меня волнуют такие вещи, как номер версии, в которую он был добавлен, а не дата.
Вам следует настроить шаблоны файлов: jetbrains.com/help/idea/using-file-and-code-templates.html