2013-04-22 11 views
16

注釈@paramはどのように機能しますか?私はこのような何かを持っていた場合@paramが正しく動作する方法 - Java

/* 
*@param testNumber; 
*/ 

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

はどのよう@paramはtestNumberに影響を与えるのでしょうか?それはtestNumberにも影響しますか?

ありがとうございました。私が間違って使用した場合は教えてください。

+2

'/ **'で始まり '* /'で終わるブロックは 'javadoc'だけで処理されます。それらはJavaコンパイラによって「コメント」として扱われます。 –

答えて

11

@paramは、数値には影響しません。私はそれがjavadocsを作るためだと信じています。

のjavadocの詳細: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

+1

私が知っている限りこれは正しいです。あなたは '@param blahblah'を置くことができ、JDがパラメータ' blahblah'を生成するようになります。 –

+0

paramはメソッドに影響しません。メソッドの詳細を見るときに必要なものが表示されます(押された後、メソッドの上にマウスカーソルを置いてください)。@paramの後にさらにパラメータを追加すると –

19

@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) { 
2

@paramはtestNumber.ItがJavadocでは影響はありませんコメント - ドキュメントの生成に使用されます。 @param,@returnなどのように、クラス、フィールド、メソッド、コンストラクタ、またはインターフェイスの直前にJavadocコメントを置くことができます。 一般に '@'で始まり、行の最初のものでなければなりません。

@paramを使用する利点: - 属性とカスタムJavadocタグを含む単純なJavaクラスを作成することで、これらのクラスをコード生成のための簡単なメタデータ記述として使用できます。あなたのコード内であなたがtestNumberIsValidメソッドを再利用する場合たび

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

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

、IDEはあなたの方法が受け入れるパラメータを示し、方法の種類を返します。

0

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

関連する問題