Есть ли какие-либо инструменты для обновления Javadoc автоматически?
О, также самое быстрое было бы:
string cat = "cat";
string s = "The " + cat + " in the hat";
3 ответа
В NetBeans есть инструмент для этого. Он делает именно то, что вы просите.
Вы можете либо щелкнуть меню Инструменты , затем Анализировать Javadocs сверху,
или щелкните файл правой кнопкой мыши и выберите Инструменты , затем Анализировать Javadocs .
После этого вы получите список всех проблем, которые он обнаруживает с вашими Javadocs, с возможностью их устранения. Он позволяет исправить одну проблему в методе, исправить документацию javadoc для метода, для файла, для пакета или для всего проекта.
Я не пробовал ничего из этого, кроме DocCheck, но эта несколько устаревшая страница на сайте Sun перечисляет несколько сторонних документов, некоторые из которых предназначены для вставки документации Javadoc в ваш источник. Из них вы можете взглянуть на Doc-o-Matic , JRefactory Pretty Printer и ACTOS Auto Commentator для Java . Опять же, я не пробовал ничего из этого, но это место для начала.
Одно из решений, если вы используете eclipse, - это перейти в Window -> Preferences -> Java -> Compiler -> Javadoc
а затем установите для переменной «Неправильные комментарии Javadoc» значение «Предупреждение» или «Ошибка».
Затем вы можете перейти к представлению проблем Окно -> Показать представление -> Проблемы , а затем для каждой ошибки щелкните правой кнопкой мыши и выберите « Быстрое исправление ».