こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。
この記事では、 Javadocでバージョンを指定できる@versionタグについて解説していきます。
前提条件：実行環境について
実行環境は以下の通りです。
| OS | Windows10 |
|---|---|
| IntelliJ IDEAのエディション | Community(無料版) |
| IntelliJ IDEAのバージョン | 2021.3.2 |
| プロジェクト | Javaプロジェクト |
| SDK | Oracle OpenJDK version17.0.2 |
Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。
@versionタグとは
@versionタグとは、Javadocのタグの1つでソフトウェアの現在のバージョンを指定できるタグです。
使い方サンプルは以下になります。
|
1 2 3 4 |
/** * サンプルクラス * @version 1 */ |
注意点として、@versionタグはメソッドやフィールドに対しては使っても反映されません。
では、次の章で実際にJavadocを作成してみます。
@versionタグのサンプルプログラム
以下のプログラムでJavadocを作成します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
package sample; /** * Testクラス * @version 1.0.1 */ public class Test { /** * あいさつを返す * @return こんにちは */ public static String getGreetings() { return "こんにちは"; } } |
実行結果
Javadocを作成します。
IntelliJ IDEAでJavadocを作成するやり方は、こちらの記事をご参考ください。
バージョンの項目に指定した値が表示されていることが確認できました。
まとめ：versionタグを使ってみよう！
以上がJavadocの@versionタグについての解説でした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント