2013-04-22 3 views
16

어노테이션 @param의 작동 방식은 무엇입니까? 나는 이런 식으로 뭔가가 있다면@param 작동법 - Java

:

/* 
*@param testNumber; 
*/ 

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

어떻게 @param는 testNumber에 영향을 미칠까요? 그것은 심지어 testNumber에 영향을 미칩니 까?

감사합니다. 내가 틀 렸는지 알려줘.

+2

'/ **'로 시작하고'* /'로 끝나는 블록은'javadoc'에 의해서만 처리됩니다. 그것들은 Java 컴파일러에 의해'comments'로 취급됩니다. –

답변

11

@param은 숫자에 영향을주지 않습니다. 나는 javadocs를 만들기위한 것이라고 생각한다. 자바 독에

더 : http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

+1

알고있는 한 정확합니다. '@param blahblah'를 넣으면 JD가 매개 변수'blahblah'를 생성하게됩니다. –

+0

param은 메서드에 영향을주지 않습니다. 메서드에 대한 세부 정보를 볼 때 필요한 것을 보여줍니다 (누른 후에 메서드 위로 마우스를 가져 가면됩니다.) 매개 변수에 대한 자세한 정보를 제공하기 위해 @param 뒤에 더 추가 할 수도 있습니다 –

19

@param는 문서를 생성하기 위해 javadoc의 사용하는 특수한 형식의 코멘트입니다. 메소드가 수신 할 수있는 매개 변수 (또는 매개 변수)에 대한 설명을 나타내는 데 사용됩니다. 이것은

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

다른 것들 사이에있다 : 또한 반환 값과 각각 관련 정보를 설명하는 데 사용 @return@see있다

/** 
* 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입니다 comment - 문서 생성에 사용됩니다. @param, @return과 같은 클래스, 필드, 메서드, 생성자 또는 인터페이스 바로 앞에 Javadoc 설명을 넣을 수 있습니다. 일반적으로 '@'으로 시작하며 줄의 첫 번째 항목이어야합니다.

@param을 사용할 때의 이점은 다음과 같습니다. - 속성 및 사용자 정의 Javadoc 태그가 포함 된 간단한 Java 클래스를 작성하면 해당 클래스를 코드 생성을위한 간단한 메타 데이터 설명으로 사용할 수 있습니다. 코드에서 당신이 testNumberIsValid 방법을 다시 사용하는 경우 때마다

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

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

, IDE는 당신에게 방법을 허용하는 매개 변수를 표시하고 방법의 유형을 반환합니다.

0

기본적으로 코멘트입니다. 우리가 아는 바와 같이 동일한 프로젝트를 수행하는 많은 사람들이 코드 변경에 대한 지식을 가지고 있어야합니다. 우리는 매개 변수에 대해 프로그램에서 몇 가지 메모를하고 있습니다.