@param
日本語 | 引数 |
英語 | atmark parameter |
ふりがな | ぱらむ |
フリガナ | パラム |
「引数」を出力するためのタグ。
Javadocのタグのひとつ。メソッドのドキュメンテーションコメント内に「@param 引数名 説明」と記述することで、Javadocによって出力されたメソッドの仕様に、「パラメータ: 引数名 - 説明」という記述が出力される。
Javadocのタグのひとつ。メソッドのドキュメンテーションコメント内に「@param 引数名 説明」と記述することで、Javadocによって出力されたメソッドの仕様に、「パラメータ: 引数名 - 説明」という記述が出力される。
参考サイト
// Sample.java
public class Sample
{
/**
* main()メソッド。<br>
* 最初に呼ばれるメソッドです。
* ↓これ。
* @param args javaコマンド実行時に渡されるパラメーターが入っています。
*/
public static void main( String[] args )
{
int result = toInt( "100" );
System.out.println( result );
// 100
}
}
/*
あとは、javadocコマンドで出力します。
>javadoc -d html src/*.java
この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。
*/
public class Sample
{
/**
* main()メソッド。<br>
* 最初に呼ばれるメソッドです。
* ↓これ。
* @param args javaコマンド実行時に渡されるパラメーターが入っています。
*/
public static void main( String[] args )
{
int result = toInt( "100" );
System.out.println( result );
// 100
}
}
/*
あとは、javadocコマンドで出力します。
>javadoc -d html src/*.java
この例では、srcディレクトリ内のソースファイルのドキュメントを
htmlディレクトリに出力します。
*/
// Sample.java public class Sample { /** * main()メソッド。<br> * 最初に呼ばれるメソッドです。 * ↓これ。 * @param args javaコマンド実行時に渡されるパラメーターが入っています。 */ public static void main( String[] args ) { int result = toInt( "100" ); System.out.println( result ); // 100 } } /* あとは、javadocコマンドで出力します。 >javadoc -d html src/*.java この例では、srcディレクトリ内のソースファイルのドキュメントを htmlディレクトリに出力します。 */