こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在4社経験している、11年目エンジニアです。
この記事では、 Javadocでメソッドの引数を説明する@paramタグについて解説していきます。
前提条件：実行環境について
実行環境は以下の通りです。
| OS | Windows10 |
|---|---|
| IntelliJ IDEAのエディション | Community(無料版) |
| IntelliJ IDEAのバージョン | 2021.3.2 |
| プロジェクト | Javaプロジェクト |
| SDK | Oracle OpenJDK version17.0.2 |
Javaを動かすためにIntelliJ IDEAを使っています。
IntelliJ IDEAのインストールは、下の記事をご参考ください。
@paramタグとは
@paramタグとは、Javadocのタグの1つでメソッドの引数を説明するタグです。
使い方サンプルは以下になります。
|
1 2 3 4 5 6 |
/** * 【メソッドの説明】 * @param 【引数名1】 【引数名1の説明】 * @param 【引数名2】 【引数名2の説明】 * … */ |
@paramタグは引数の説明なので、メソッドに対してのみ、そして複数使うことができます。
注意点として以下のようにメソッドの引数以上の@paramを指定してJavadocを生成しようとした場合
|
1 2 3 4 5 6 7 8 9 |
/** * 偶数判定 * @param number 数字 * @param error エラー * @return */ public static boolean isEvenNumber(int number) { return number % 2 == 0; } |
|
1 |
エラー: @param nameが見つかりません |
とエラーとなり、Javadocを生成できません。
指定する@paramタグの数にはご注意ください。
では、次の章で実際にJavadocを作成してみます。
@paramタグのサンプルプログラム
以下のプログラムでJavadocを作成します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
package sample; public class Calculation { /** * 円の面積を計算する * @param radius 半径 * @return 面積 */ public static double calcCircleArea(double radius) { return radius * radius * Math.PI; } /** * 長方形の面積を計算する * @param warp 縦 * @param weft 横 * @return 面積 */ public static int calcRectangleArea(int warp , int weft) { return warp * weft; } } |
実行結果
Javadocを作成します。
IntelliJ IDEAでJavadocを作成するやり方は、こちらの記事をご参考ください。
@paramタグに指定した内容が表示されていることが確認できました。
まとめ：paramタグを使ってみよう！
以上がJavadocの@paramタグについての解説でした！
あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ
コメント