JavaDoc : 문서에 메모/설명을 추가 할 위치는 어디입니까?

Question

C#으로 코딩 할 때 나는 항상 클래스 또는 메소드의 구현에 대한 노트를 제공하거나 내가 구현 한 이론에 대한 정보를 제공하는 데 유용한 태그 remarks을 찾았습니다. 지금 Java 사용하고 있지만 이에 대한 적절한 JavaDoc 태그를 찾을 수 없습니다. 어쩌면 자바에서 당신은 이것을 다른 방식으로 수행 할 것인가?

Answer 1

지금까지 내가 아는 한,이 외설 ' 주석이나 주석을위한 전용 Javadoc 태그. 일반적으로, Javadoc의 첫 번째 문장은 클래스/메소드/필드에 대한 간략한 설명을 제공해야합니다. 다음 전체 설명을 따라야합니다. 어떤 노트를 포함 시키길 원한다면, "Note :"가 붙은 특별한 단락만으로 충분할 것입니다.

/** 
* Brief description. Full description of the method, generally without 
* implementation details. 
* <p> 
* Note: Additional information, e.g. your implementation notes or remarks. 
* </p> 
* @param input description of the parameter 
* @return description of return value 
* 
* @since version 
* @author name of the author 
*/ 
public boolean doSomething(String input) 
{ 
    // your code 
} 

Answer 2

당신이 구현 세부 사항은 자바 독의 일부가 될 수있을만큼 흥미로운 생각한다면, 당신은 단순히 자바 독 주석 자체의 단락을 제공해야

이

/** 
* Does something. 
* <p> 
* <b>Implementation details:</b><br /> 
* Blah blah blah... 
* </p> 
*/ 
public void doSomething() { 
    // ... 
} 

Answer 3

나만의 맞춤 태그를 만들 수 있습니다.

의 javadoc -tag 노트 :

/** 
    * Quark represents a quark. 
    * 
    * @note If you spin a quark, it will spin forever! 
    */ 
    public class Quark { 

    } 

이 같은 위의 실행 javadoc에 대한의 javadoc을 생성하려면 : 여기

는 사용자 정의 태그 "@note"를 포함하는 javadoc의 코멘트입니다 "참고 :"Quark.java

출처 : http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.htm

Answer 4

Java 프로그래밍 언어의 반복 8을 통해 개발자는 코드 설명서 –에서 사용할 수있는 추가 태그 세 개를 제공 받았으며 사용자의 요구를 충족해야합니다 : @apiNote, @implSpec 및 @implNote (예 : 자세한 내용은 토론 : blog.codefx.org/java/new-javadoc-tags/).