Есть ли инструменты для автоматического обновления Javadoc? - PullRequest
Новая
       11

Есть ли инструменты для автоматического обновления Javadoc?

5 голосов
/ 07 декабря 2009

Я работаю на базе кода, которая ... грязная. Одним из аспектов этого беспорядка является то, что у нас есть тонна методов, подписи которых больше не соответствуют связанному Javadoc. Например: 

/**
 *
 * @ param foo
 */
public void doFoo(int bar) {...

Я не фанат сгенерированного Javadoc (поскольку он почти всегда бесполезен), но я действительно мог бы использовать инструмент, который бы просматривал наш код, находил подобные случаи и:

  1. удалить Javadoc для параметра "foo"
  2. добавить javadoc для параметра "bar" (но только пустой, без сгенерированного документа или чего-либо еще)

Существует ли такой инструмент? Если нет, существует ли инструмент, который просто существует # 1? Даже это значительно уменьшит количество предупреждений о мусоре, которые мы получаем в наших сборках. Спасибо.

Ответы [ 3 ]

3 голосов
/ 07 декабря 2009

В NetBeans есть инструмент для этого. Это именно то, что вы просите.

Вы можете нажать на Tools Меню, затем Analyze Javadocs сверху, или щелкните файл правой кнопкой мыши и выберите Tools, затем Analyze Javadocs.

Это даст вам список всех проблем, которые он обнаружит с вашими Javadocs, с возможностью исправить это. Он позволяет исправить одну проблему в методе, исправить javadocs для метода, для файла, для пакета или для всего проекта.

3 голосов
/ 07 декабря 2009

Одно из решений, если вы используете Eclipse, это перейти к Window -> Preferences -> Java -> Compiler -> Javadoc а затем установите для переменной 'Malformed Javadoc comments' значение предупреждение или ошибка.

Затем вы можете перейти к просмотру проблем Window -> Show View -> Problems, а затем по каждой ошибке щелкнуть правой кнопкой мыши и выбрать «Быстрое исправление».

2 голосов
/ 07 декабря 2009

Я не пробовал ничего из этого, кроме DocCheck, но на этой несколько устаревшей странице сайта Sun перечислены несколько сторонних доклетов, некоторые из которых подразумевают вставку Javadoc в ваш источник. Из них вы можете взглянуть на Doc-o-Matic , JRefactory Pretty Printer и ACTOS Auto Commentator для Java . Опять же, я не пробовал ничего из этого, но это место для начала.

...