@param
@Param 태그는 메소드 또는 생성자의 단일 매개 변수를 보관하거나 아카이브 클래스, 인터페이스 및 일반 메소드의 매개 변수를 입력 할 수 있습니다. @Param 태그를 사용하는 경우 메소드의 각 매개 변수에 대한 태그 중 하나를 사용해야합니다. 각 단락의 첫 번째 단어는 매개 변수 이름으로 간주되는 반면 나머지는 다음에 대한 설명으로 간주됩니다.
@Param Max 읽을 최대 단어 수입니다.
유형 매개 변수를 보관할 때 유형 매개 변수 이름의 양쪽에 <및>를 추가해야합니다.
@param 体中国中国中国中国
그러나 유형 매개 변수는 일반적으로 매우 명백하기 때문에 명시적인 문서가 필요하지 않습니다.
@ 보다
@see 태그는 다른 Javadoc 문서에 링크 된 교차 참조를 만들 수 있습니다. 태그 후에 식별자를 이름을 지정할 수 있지만, 그 자리를 완전히 자격을 갖추어야합니다. 예를 들어, 일반적으로 클래스 멤버의 간단한 이름으로 이름을 지정할 수 있지만 멤버가 과부하 된 메소드 인 경우 각 매개 변수의 유형을 열거하여 메소드의 과부하 된 버전을 지정해야합니다. 자격이없는 이름을 사용하여 현재 패키지 내에 인터페이스 또는 클래스를 지정할 수 있지만 다른 패키지의 유형을 지정하려면 완전히 자격있는 이름을 사용해야합니다. 멤버 이름 전에 #을 사용하여 유형의 멤버를 지정할 수 있습니다. 다음은 모두 @ 태그 형식을 참조하십시오.
@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) @seee) @seee. Object) @see com.magic.attr @see attribute specification @see "java developer 's almanac"
첫 번째 양식은 문서 주석 자체와 동일한 클래스 또는 인터페이스에 위치하거나 특정 주변 클래스 또는 주변 인터페이스에있는 getName이라는 메소드를 나타냅니다. 이러한 구문은 생성자 및 필드에도 적용될 수 있습니다. 두 번째 양식은 현재 패키지의 클래스 또는 특정 가이드 패키지의 클래스를 나타냅니다. 세 번째 양식은 자격을 갖춘 이름을 사용하는 클래스를 나타냅니다.
@see의 마지막 4 가지 형태는 첫 번째 두 가지 형태가 도메인 (Deck-Siz Day and Method (getName)에 관한 것입니다. 우리는 하나의 getName 메소드 만 attr 클래스에서 정의되기 때문에 메소드 이름을 직접 사용할 수 있습니다. 후자의 두 형태는 att 우리가 참조하려는 버전 인용문.
다음 @see 양식은 독자를 특정 패키지로 연결합니다 : com.magic.attro
마지막 두 가지 형태를 통해 다른 문서를 인용 할 수 있습니다. 그 중에서 이전에는 링크를 정의하는 데 사용하고 후자는 따옴표를 사용하여 문서 이름을 동봉합니다. 우리는 두 양식을 모두 사용하여 독자를 전체 설명서와 같은 다른 문서로 안내 할 수 있습니다.
언어 엔티티의 이름을 따서 레이블을 따라 할 수있는 @see 양식 (위의 마지막 두 형식을 제외한 모든 양식). 생성 된 문서 에서이 레이블 이름은 엔티티 이름을 대체합니다. 예를 들어:
@ #GetMeatTribute 이름을 참조하십시오
getName 문서에 대한 링크가 작성되지만 표시되는 텍스트는 "getName"대신 "속성 이름"입니다. 일반적으로 우리는 회원의 실명을 사용해야하지만 여기에 표시된 기능은 때때로 유용합니다.