web-dev-qa-db-ja.com

@paramの仕組み-Java

アノテーション@param仕事？

このようなものがあった場合：

/* 
*@param testNumber;
*/

int testNumber = 5;
if (testNumber < 6) {
   //Something
}

@param testNumberに影響しますか？ testNumberにも影響しますか？

ありがとう。間違って使用したかどうかを教えてください。

javaparam
23
user2228462

@paramは番号に影響しません。 javadocsを作成するためだけのものです。

Javadocの詳細： http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html

15
Kirsten Koa

@paramは、ドキュメントを生成するためにjavadocによって使用される特別な形式のコメントです。メソッドが受け取ることができるパラメーターの説明を示すために使用されます。戻り値と関連情報をそれぞれ説明するために使用される@returnと@seeもあります。

http://www.Oracle.com/technetwork/Java/javase/documentation/index-137868.html#format

とりわけ、これは：

/**
 * Returns an Image object that can then be painted on the screen. 
 * The url argument must specify an absolute {@link URL}. The name
 * argument is a specifier that is relative to the url argument. 
 * <p>
 * This method always returns immediately, whether or not the 
 * image exists. When this applet attempts to draw the image on
 * the screen, the data will be loaded. The graphics primitives 
 * that draw the image will incrementally Paint on the screen. 
 *
 * @param  url  an absolute URL giving the base location of the image
 * @param  name the location of the image, relative to the url argument
 * @return      the image at the specified URL
 * @see         Image
 */
 public Image getImage(URL url, String name) {
29
rmalchow

@paramはtestNumberに影響しません。これはJavadocコメントです。つまり、ドキュメントの生成に使用されます。クラス、フィールド、メソッド、コンストラクター、または@param、@returnなどのインターフェイスの直前にJavadocコメントを配置できます。通常、「@」で始まり、行の最初のものでなければなりません。

@paramを使用する利点は次のとおりです。属性といくつかのカスタムJavadocタグを含む単純なJavaクラスを作成することにより、これらのクラスをコード生成の単純なメタデータ記述として使用できます。

    /* 
       *@param testNumber
       *@return integer
    */
    public int main testNumberIsValid(int testNumber){

       if (testNumber < 6) {
          //Something
        }
     }

コード内でtestNumberIsValidメソッドを再利用する場合、IDEはメソッドが受け入れるパラメーターを表示し、メソッドの型を返します。

3
user2354660

基本的にはコメントです。私たちが知っているように、同じプロジェクトに取り組んでいる多くの人々は、コードの変更に関する知識を持っている必要があります。プログラムでは、パラメーターについていくつかのメモを作成しています。

0
Rahul