Можно ли добавить блок комментариев (стиль Javadoc) к каждому методу в проекте Eclipse и, возможно, к классам, чтобы я мог заполнить их позже?
Как и было предложено, вы можете использовать метод method-per-method (Source → Generate element comment) или ALT+SHIFT+J, но я нахожу его очень плохим. Комментарии полезны только тогда, когда они дают дополнительную информацию. Когда вы чувствуете, что требуется дополнительная информация, добавьте его.
Имея комментарии к сеттерам, такие как "устанавливает значение" или, что еще хуже, автоматически генерируемые комментарии, это вообще не полезно.
В <
Окно | Настройки | Java | Стиль кода | Шаблоны кода
вы найдете две функции:
Вы можете редактировать сгенерированный блок комментариев с помощью переменных eclipse или вашего статического текста Javadoc.
Чтобы добавить комментарий к методу выберите getUser или , возьмите курсор перед getUser и нажмите ALT + SHIFT + J. Он добавит комментарий поверх вашего метода
/*
* @param
* @return User
*/
public User getUser();
Возможно, вы ищете это
Простая вещь: просто введите /** и нажмите Ввести в верхней части метода, где вы хотите сгенерировать комментарий .it автоматически генерирует комментарий элемента. Не нужно долго заходить..
используйте следующие шаги, и вы сделаете это легко. в eclipse перейдите в Project → сгенерируйте javadoc → нажмите enter, а затем выберите проект для документирования.
Пользователи Mac: ⌃ - ⌥ - J
Пользователи Windows: Shift - Alt - J
PS: Убедитесь, что установлен JAutodoc