Question

如何让NetBeans 8.1+自动将@author标记添加到我编辑的类的JavaDoc中？

Answer 1

最接近在Netbeans中自动执行此过程的方法是在提交到存储库之前运行Tools -> Analyze Javadoc并勾选所有蓝色（已修改）和绿色（ new ）缺少类的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>

NetBeans - 在代码更改时自动将@author添加到类中

1 个答案: