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



我有一个包含大量文件的Java项目。在某些情况下,我在类/接口声明之前插入了JavaDoc @author标签,但不是全部。我想要一个脚本(bash, perl,无论什么)能够在正确的位置添加@author标签(就在类声明之前)为所有没有一个的文件。如何找到添加javadoc的正确行?:

/*
 * @author alepac
 */

不是一个脚本,但如果你的Java项目恰好是用Maven构建的,那么你可以使用javadoc插件的javadoc:fix目标,你可以配置它,这样它就会插入@author标记,无论它缺失的地方,包括根本没有javadoc的情况:

<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>

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

#!/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`"

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

希望能有所帮助。

最新更新