Java에서 @param 주석과 @see 주석의 역할에 대한 간략한 토론

@ param
@ param 태그는 메서드나 생성자의 단일 매개 변수나 클래스, 인터페이스 또는 일반 메서드의 유형 매개 변수를 보관할 수 있습니다. @param 태그를 사용할 때 메소드의 각 매개변수에 하나씩 사용해야 합니다. 각 단락의 첫 번째 단어는 매개변수 이름으로 처리되고 나머지 부분은 설명으로 처리됩니다.

@param max The maximum number of words to read.

유형 매개변수를 보관할 때 유형 매개변수 이름이 앞에 와야 합니다. by 709755eb0d440af414163d2e5288b1b1:

@param一e element type of this List

그러나 유형 매개변수는 그 의미가 분명하기 때문에 일반적으로 명시적인 문서가 필요하지 않습니다.

@ see
@ see 태그는 다른 javadoc 문서에 연결되는 상호 참조를 생성할 수 있습니다. 이 태그 뒤에는 식별자의 이름을 지정할 수 있지만 식별자를 정규화해야 합니다. 예를 들어 일반적으로 간단한 이름으로 클래스 멤버의 이름을 지정할 수 있지만 멤버가 오버로드된 메서드인 경우 각 매개 변수의 형식을 열거하여 메서드의 오버로드된 버전을 지정해야 합니다. 현재 패키지에서 인터페이스나 클래스를 지정하려면 정규화되지 않은 이름을 사용할 수 있지만, 다른 패키지에서 형식을 지정하려면 정규화된 이름을 사용해야 합니다. 멤버 이름 앞에 #을 사용하여 유형의 멤버를 지정할 수 있습니다. 다음은 모두 유효한 @see 태그 형식입니다.

@see #getName
 
@see Attr
 
@see com.magic.attr.Attr
 
@see com.magic.attr.Deck#DECK-SIZE
 
@see com.magic.attr.Attr#getName
 
@see com.magic.attr.Attr#Attr(String)
 
@see com.magic.attr.Attr#Attr(String，Object)
 
@see com.magic.attr
 
@see Attribute Specification
 
@see "The Java Developer's Almanac"

첫 번째 형식은 문서 주석 자체와 함께 있는 getName이라는 메서드를 참조합니다. 이 구문은 다음과 같습니다. 동일한 클래스나 인터페이스 또는 주변 클래스나 인터페이스 내의 생성자와 필드에도 적용할 수 있습니다. 두 번째 형식은 현재 패키지의 클래스 또는 가져온 패키지의 클래스를 참조합니다. 세 번째 형식은 정규화된 이름을 사용하는 클래스를 참조합니다.

@see의 마지막 4개 형식은 멤버를 참조하며, 그 중 처음 2개는 도메인(DECK-SIZ)과 메소드(getName)에 대한 것이므로 Attr에 있으므로 메소드 이름을 직접 사용할 수 있습니다. class 단 하나의 getName 메소드가 정의되어 있습니다. 후자의 두 형식은 Attr 클래스의 생성자를 참조합니다. 한 생성자는 문자열 인수를 받아들이고 다른 생성자는 문자열과 객체를 받아들입니다. 또는 메소드에 오버로드된 버전이 있는 경우 참조하려는 오버로드된 버전의 인수를 지정해야 합니다. 다음 @see 형식은 독자를 특정 패키지로 안내합니다: com.magic.attro<.>

마지막 두 형식을 사용하면 다른 문서를 참조할 수 있습니다. 전자는 링크를 정의하는 데 사용하고 후자는 따옴표를 사용하여 문서 이름을 묶습니다.

@see 형식의 이름 지정과 같은 다른 문서를 사용할 수 있습니다. 언어 엔터티(위의 마지막 두 양식을 제외한 모든 양식) 뒤에는 레이블이 올 수 있습니다. 생성된 문서에서 이 레이블의 이름은 엔터티의 이름을 대체합니다. 예:

@ see #getNameAttribute Names

은 getName 문서에 대한 링크를 생성하지만 표시되는 텍스트는 "getName" 대신 "속성 이름"입니다. 일반적으로 멤버의 실제 이름을 사용해야 하지만 여기에 표시된 기능은 때때로 유용할 수 있습니다.

Java의 @param에 대한 추가 팁 및 @see 주석의 역할과 관련된 기사는 PHP 중국어 웹사이트를 참조하세요.