Javadoc을 사용하여 Java Enum을 문서화하는 가장 좋은 방법은 무엇입니까?

StackOverflow https://stackoverflow.com/questions/195020

  •  10-07-2019
  •  | 
  •  

문제

방금 내 프로젝트에서 Java의 열거를 사용하기 시작했으며 (직장에서 JDK 1.4를 사용해야합니다) 열거에 Javadoc을 사용하는 모범 사례에 대해 혼란스러워합니다.

이 방법이 작동한다는 것을 알았지 만 결과 코드는 약간 정제되지 않았습니다.

/**
* Doc for enum
*/
public enum Something {
/**
* First thing
*/
FIRST_THING,
/**
* Second thing
*/
SECOND_THING;
//could continue with more
}

쉼표로 체인하지 않고 자신의 라인에서 열거 선언을 분해 할 수있는 방법이 있습니까?

도움이 되었습니까?

해결책

질문의 첫 번째 부분에 답하려면 각 열거 값을 쉼표로 분리해야합니다. 내가 아는 한, 그 주위에는 아무런 방법이 없습니다.

개인적으로 나는 당신이 제시 한 방식으로 코드에 문제가 없습니다. 나에게 열거를 문서화하는 완벽하게 합리적인 방법 인 것 같습니다.

다른 팁

Mike가 언급했듯이, 열거 값을 쉼표로 분리해야하며, 열거 선언에 가장 먼저 나열된 것 (인스턴스 변수, 상수, 생성자 및 메소드가 따라갈 수 있음)이어야합니다.

열거를 문서화하는 가장 좋은 방법은 일반 클래스와 유사하다고 생각합니다. 열거 유형은 열거의 기능과 역할에 대한 설명을 전체적으로 얻습니다 (”Something values are used to indicate which mode of operation a client wishes...") 그리고 각 열거 값은 그 목적과 기능에 대한 Javadoc 설명을 얻습니다 ("FIRST_THING indicates that the operation should evaluate the first argument first..").

열거 값 설명이 짧은 경우 한 줄에 한 줄에 넣을 수 있습니다. /** Evaluate first argument first. */, 그러나 각 열거 값을 자체 라인에 유지하는 것이 좋습니다. 대부분의 IDE는 이러한 방식으로 자동으로 포맷하도록 구성 할 수 있습니다.

Google 코드 검색 온라인 도구가 있습니다. http://www.google.com/codesearch

나는 같은 일을함으로써 물건을 조회하려고 노력합니다 "Lang : Java Public Enum"

태양의 예

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top