Как я могу сделать NetBeans 8.1+ для автоматического добавления тега @author в JavaDoc класса, который я редактирую?NetBeans - автоматически добавляет @author к классу при изменении кода
ответ
Ближайшие иметь этот процесс автоматизирован в Netbeans, чтобы запустить Tools -> Analyze Javadoc
перед фиксацией в хранилище и отметьте все синие (модифицированный) и зеленый (новых) запись для пропавших без вести Javadoc для класса. Однако этот процесс не добавит тега @author
, если комментарий для класса уже существует или не обновляет существующий тег. Вот the manual.
Я не уверен в целесообразности автоматической маркировки каждого файла, который был затронут как автор того, кто его коснулся, хотя это может быть причиной того, что такая функция недоступна. Класс, который изменился на 1%, заслуживает изменения автора? Как насчет 40%? Как насчет перестановки импорта? и так далее ... Думаю, можно было бы найти альтернативное решение, например, ввести @lasteditor
или несколько тегов @author
или @editor
, но я все еще не уверен, что это добавит большой ценности.
git blame
(Team -> Show Annotations
), git log
и т. Д., Похоже, больше подходят для задачи отслеживания авторов и редакторов.
Одним из вариантов решения, по крайней мере, для проектов Maven, может быть javadoc:fix целью Javadoc plugin, но это только гарантировало бы, что каждый класс Javadoc имеет @author
тега и ничего фантазию кроме того:
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<groupId>org.apache.maven.plugins</groupId>
<version>2.10.3</version>
<configuration>
<fixTags>author</fixTags>
<force>true</force>
<fixFieldComment>false</fixFieldComment>
<fixMethodComment>false</fixMethodComment>
</configuration>
</plugin>
полезности объявлений - это в основном до команды, чтобы понять. Не весь код всегда покрывается SCM. И добавление автора в файл подходит для будущих редакторов, потому что предыдущий, скорее всего, изучил файл и может быть задан вопрос о деталях. На самом деле речь идет не о «утверждении» авторства. Вероятно, это ваше предположение. –
Я просто указывал на то, что разработчик Netbeans может подумать при рассмотрении этой функции, как инструмент может определить, что изменение достаточно значимо для того, чтобы гарантировать обновление тега '@ author', или же оно должно заботиться об этом вообще в этом случае, скажем, простое исправление опечатки приведет к обновлению. Лично я думаю, что в описанных вами обстоятельствах отдельный документ readme или changlog, предоставляющий больше контекста, будет работать лучше, чем творческое использование тега '@ author', но, как вы сказали , это для команды, чтобы решить. –