Java의 주석 @param

Java에서 주석은 메타데이터를 나타내는 태그로 클래스, 인터페이스, 메소드 등과 함께 첨부되어 JVM 및 Java 컴파일러에서 사용할 수 있는 몇 가지 특수한 유형의 추가 정보를 나타냅니다.

@param 주석은 문서를 생성하는 javadoc에서 사용하는 특수 형식 주석입니다.

이 튜토리얼에서는 @param 주석이 Java에서 어떻게 작동하는지 논의할 것입니다.

위에서 언급했듯이 @param은 문서를 생성하는 javadoc에서 사용하는 특수한 형식의 주석입니다. 메소드가 수신할 수 있는 매개변수(또는 여러 매개변수)에 대한 설명을 나타냅니다.

반환 값 및 관련 정보를 설명하는 @return 및 @see와 같은 주석도 있습니다.

특정 방법에서 사용되는 경우 이 주석은 작업 방법에 영향을 미치지 않습니다. 특정 방법에 대한 문서를 만드는 데만 사용됩니다. 이 주석을 클래스, 메서드, 필드, 생성자, 인터페이스 등 바로 앞에 놓을 수 있습니다.

이 주석을 사용할 때의 이점은 속성과 일부 사용자 정의 javadoc 태그를 포함할 수 있는 간단한 Java 클래스가 코드 생성을 위한 간단한 메타데이터 설명 역할을 할 수 있다는 것입니다.

예를 들어,

/*
 *@param number
 *@return integer
 */
public int main number(int num) {
  // if number is less than 5, square it
  if (num < 5) {
    num = num * num;
  } else {
    // else add the number to itself
    num = num + num;
  }
  return num;
}

위의 예에서 number() 메소드는 나머지 코드에 대한 메타데이터 역할을 합니다. 코드가 이 메서드를 재사용할 때마다 IDE는 이 메서드가 허용하는 매개변수를 표시합니다. 이 경우 하나의 매개변수가 허용되며 이는 num이라는 정수입니다. 또한 메서드의 반환 유형은 이 경우 int입니다.