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

时间:2013-04-23 12:17:18

标签: javadoc author

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

/*
 * @author alepac
 */

2 个答案:

答案 0 :(得分:0)

您可以尝试使用以下脚本

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

让我知道它是否对您有所帮助,或者这是否与您正在寻找的无关。

希望它有所帮助。

答案 1 :(得分:0)

不是脚本,但如果您的Java项目恰好使用Maven构建,那么您可以使用javadoc:fix Javadoc plugin目标,您可以配置它以便插入{{1}标签丢失的地方,包括根本没有javadoc的情况:

@author