こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、15年目エンジニアです。
この記事では、 Javadocでメソッドの戻り値を説明する@returnタグについて解説していきます。
前提条件：実行環境について
実行環境は以下の通りです。
| OS | Windows11 |
|---|---|
| IntelliJ IDEAのエディション | Community(無料版) |
| IntelliJ IDEAのバージョン | 2023.2 |
| プロジェクト | Javaプロジェクト |
| SDK | openjdk-24 |
Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。
@returnタグとは
@returnタグとは、Javadocのタグの1つでメソッドの戻り値を説明するタグです。
@returnタグは1つのメソッドに1回だけ書くことができます。
使い方サンプルは以下になります。
|
1 2 3 4 |
/** * 【メソッドの説明】 * @return 【戻り値の説明】 */ |
もし戻り値がvoidの場合は、指定しなくてもOKです。
では、次の章で実際にJavadocを作成してみます。
@returnタグのサンプルプログラム
以下のプログラムで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 |
public class Calculate { /** * val1とval2を足し算するメソッド * @param val1 足し算する値その1 * @param val2 足し算する値その2 * @return val1とval2を足し算した結果 */ public int addInteger(int val1, int val2){ return val1 + val2; } /** * val1からval2を引き算するメソッド * @param val1 引き算される値 * @param val2 引き算する値 * @return val1からval2を引き算した結果 */ public int subInteger(int val1, int val2){ return val1 - val2; } /** * Helloを表示するメソッド */ public void printHello() { System.out.println("Hello"); } } |
実行結果
Javadocを作成します。
IntelliJ IDEAでJavadocを作成するやり方は、こちらの記事をご参考ください。
@returnタグに指定したメソッドは表示されて、指定してないメソッドは表示されていないことが確認できました。
まとめ：returnタグを使ってみよう！
以上がJavadocの@returnタグについての解説でした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント