こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。
この記事では、 Javadocで作成者名を指定できる@authorタグについて解説していきます。
前提条件：実行環境について
実行環境は以下の通りです。
| OS | Windows10 |
|---|---|
| IntelliJ IDEAのエディション | Community(無料版) |
| IntelliJ IDEAのバージョン | 2021.3.2 |
| プロジェクト | Javaプロジェクト |
| SDK | Oracle OpenJDK version17.0.2 |
Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。
@authorタグとは
@authorタグとは、Javadocのタグの1つで作成者名を指定できるタグです。
使い方サンプルは以下になります。
|
1 2 3 4 5 |
/** * サンプルクラス * @author sample * @author test */ |
@authorタグは上記のように複数回使うこともできます。
注意点として、@authorタグはメソッドやフィールドに対しては使っても反映されません。
では、次の章で実際にJavadocを作成してみます。
@authorタグのサンプルプログラム
以下のプログラムでJavadocを作成します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
package user; /** * User * @author taira */ public class User { private int age; private String name; /** * getter age * @return age */ public int getAge() { return age; } /** * setter age * @param age */ public void setAge(int age) { this.age = age; } /** * getter name * @return name */ public String getName() { return name; } /** * setter name * @param name */ public void setName(String name) { this.name = name; } } |
実行結果
Javadocを作成します。
IntelliJ IDEAでJavadocを作成するやり方は、こちらの記事をご参考ください。
作成者の欄に指定した名前が表示されていることが確認できました。
まとめ：authorタグを使ってみよう！
以上がJavadocの@authorタグについての解説でした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント