javadoc - 将 JavaDoc @author 标签添加到我项目中的每个 java 文件

Question

我有一个包含很多文件的 Java 项目。在其中的一些中，我在类/接口声明之前插入了一个 JavaDoc @author 标记，但不是全部。我想要一个脚本（bash、perl 等）能够为所有没有的文件在正确的位置（就在类声明之前）添加@author 标签。何找到添加此 javadoc 的正确行？：

/*
 * @author alepac
 */

Answer 1

不是脚本，但如果您的 Java 项目恰好是使用Maven构建的，那么您可以使用Javadoc 插件的javadoc:fix目标，您可以对其进行配置，以便它在缺少的地方插入标签，包括根本没有 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>

Answer 2

您可以尝试使用以下脚本，

#!/bin/bash

function proccess_all_files {
FILES="./*"
cd "$1"
for i in $FILES
do
if [[ -d "$i" ]]; then
echo "Directory $i found...no action taken"
else
echo "Processing $i file..."
sed '/*
 * @author alepac
 */' $i > $i.bak
mv "$i.bak" "$i"
fi
done
for j in * .[!.]* ..?*; do
cd "$1"
test -d "$1/$j" && proccess_all_files "$1/$j"
done
}

proccess_all_files "`DIRECTORY NAME`"

让我知道它是否对您有帮助，或者这是否正是您正在寻找的。

希望能帮助到你。