Как я могу автоматически обновлять Javadoc при изменении подписи метода в Eclipse?

Question

Я использую Eclipse IDE для своего Java-проекта.

У меня есть одна проблема. У меня есть методы в моем проекте, которые имеют комментарии JavaDoc как выглядит следующим образом:

/** 
* Retruns the string representation of a input stream 
* @param in 
* @return 
* @throws IOException 
*/ 
public static String getStringFromInputStream (InputStream in) throws IOException { 
    StringBuffer out = new StringBuffer(); 
    byte[] b = new byte[4096]; 
    for (int n; (n = in.read(b)) != -1;) { 
     out.append(new String(b, 0, n)); 
    } 
    return out.toString(); 
} 

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

Answer 1

Нажмите Atl+Shift+R и изменить

Answer 2

Я не знаю, как автоматически синхронизировать заголовок Javadoc, но если вы переименуете параметр с помощью Ctrl-1 + Rename in file, заголовок Javadoc соответствующим образом переименован.

Answer 3

Eclipse, обеспечивает достаточно хорошие варианты, чтобы обеспечить правильность Javadoc кроме реорганизовать Rename JesperE упоминается:

• Изменить метод подписи операция рефакторинга также модифицирует Javadoc (добавить/удалить необходимые тег). Вы должны использовать этот или Переименовать, чтобы изменить код, который уже используется.
• Если активировать Добавить Javadoc теги на Preferences/Java/редактор/Typing страницу, то Eclipse, генерирует правильный JavaDoc окурок после ввода /** + Введите перед методом.

Вы также можете установить параметры компилятора для проверки JavaDoc недостающих тегов на Preferences/Java/Compiler/Javadoc. В этом случае вы получаете предупреждения от компилятора о отсутствующих/дополнительных тегах, и у вас есть quickfix (Ctrl + 1) для их исправления. Это хороший вариант для обеспечения правильности существующих javadocs в долгосрочной перспективе.

Answer 4

Рефакторинг с опцией «ссылки Update» не является достаточным. Вы должны убедиться, что «Обработать комментарии Javadoc» отмечен в Window-> Preferences, Java-> Compiler-> Javadoc. Измените предпочтительную страницу, как вы предпочитаете, и она будет работать нормально.

Answer 5

Как я уже прокомментировал ситуацию, в которой рефакторинг не будет работать

Все ответы относятся реорганизовать вариант. Но что, если бы я добавил новый параметр или удалил параметр из подписи метода. В этом случае, как обновить javadoc?

Существует обходной путь я нашел, но да, это еще не автоматизированный процесс и не подходит для большого количества изменений.

Обойти это,
1. удалить JavaDoc комментарий и сделать его простым комментарий т.е. обновить /**' and change it to just/*».
2. Теперь еще раз под формулой/декларацией метода введите /** и нажмите enter. Он будет повторно заполнять обновленные параметры и возвращать информацию.Теперь просто переместите строки описания из старого комментария в новое.
3. Вы можете использовать Alt + Up/вниз стрелки для достижения этой цели.
4. Готово удалить старый комментарий javadoc после его скопирования в правильном месте.

Answer 6

Просто нажмите ALT + SHIFT + J на ​​имя метода и удалить лишние строки:

ДО:

/** 
* Copies all the details from the passed template into the passed new 
* header. 
* 
* @param pNewHeader 
*/ 
private void doCopy(int pNewHeader, int pTemplate) { 

ПОСЛЕ:

/** 
* Copies all the details from the passed template into the passed new 
* header. 
* 
* @param pNewHeader << DELETE 
*/     << DELETE 
/**     << DELETE 
* @param pNewHeader 
* @param pTemplate 
*/ 
private void doCopy(int pNewHeader, int pTemplate) {