'javadoc 유형'- 회원에 대한 맞춤 매개 변수를 정의하는 방법이 있습니까?

Question

내가 생각할 수있는 사용 사례는 다음과 같습니다.

일반적으로 특정 카테고리의 구성원이 많습니다. 예를 들어 웹 응용 프로그램에는 많은 상수 속성 키, 동작 클래스, 서비스 등이 있습니다. 각 카테고리에 대해 일관성을 유지하려면 일관되게 문서화하는 것이 유용합니다.

는 속성 키에 사용되는 상수를 고려

/** 
* Request scope attribute key of the {@link com.acme.domain.User} object added by the {@link LoginAction}. 
*/ 
public static final String USER_KEY = "com.acme.web.user"; 

각의 범위를 문서화 일반적으로해야 속성 키는 그것을 설정 그 아래에 저장된 객체의 유형, 그리고 누가가 있습니다.

물론

/** 
* @AttributeKey 
* @scope request 
* @type com.acme.domain.User 
* @source com.acme.web.action.LoginAction#processLogin() 
* @for HomePage.jsp 
*/ 
public static final String USER_KEY = ...; 

이 렌더링 된 문서 태그 렌더링을 위해 영어로 번역해야합니다 다음과 같이 'javadoc의 유형/범주는'사용됩니다. 위 스키마의 중요한 부분은 @AttributeKey 태그입니다. 이는 문서 작성자가 모든 필수 필드 또는 얼굴 경고 메시지를 포함하도록합니다.

나는 자바에 그런 것이 존재하지 않는다는 것이 거의 긍정적이지만, 보람 있고 다른 언어/문서 시스템에는 그러한 특징이 있는가?

Answer 1

annotations은 당신이 말하는 (종류, 의미, 제약 조건, 계약 등)에 더 적합하다고 생각해야합니다.