javadoc - プロジェクト内のすべての Java ファイルに JavaDoc @author タグを追加します

Question

たくさんのファイルを含む Java プロジェクトがあります。このいくつかでは、クラス/インターフェース宣言の直前に JavaDoc @author タグを挿入しましたが、すべてではありません。@author タグを持たないすべてのファイルの正しい位置 (クラス宣言の直前) に @author タグを追加できるスクリプト (bash、perl など) が必要です。この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`"

それが役に立ったかどうか、またはこれがまさにあなたが探しているものかどうかを教えてください.

それが役に立てば幸い。