プロジェクト内の JAVADOC コメントで特定の URL を参照したい。ただし、近い将来、URL が変更される可能性があることは承知しています。そこで、プロジェクト全体でこの URL の代わりに単一の変数を使用できる機能を探していました。必要に応じて簡単に変更できるようにしましたが、見つかりませんでした。
これを達成する方法はありますか?
javadoc 仕様ドキュメントを調べると、次のタグが表示されます。{@value}
静的フィールドでなければならない定数の値を表示します。
たとえば、クラスを作成してそこでDocLinksHolder
静的フィールドを宣言すると、javadoc でそれらを参照できます。
{@value DocLinksHolder#fieldName}
Maven を使用している場合は、そのフィルタリング機能を使用できます。
これを pom に入れます:
<resources>
<resource>
<directory>src/main/java</directory>
<filtering>true</filtering>
</resource>
</resources>
Maven は ${something} に一致するすべての文字列を検索し、pom からの値に置き換えます。
たとえば、次のように入力できます。
/**
* URL is ${url}.
*/
そしてあなたのポンで:
<properties>
<url>myUrl.com</url>
</properties>