@Java로 주석 문서화

@Java로 주석 문서화

의 목적은 무엇입니까?@Documented자바로 된 주석?

저는 그 문서를 보았지만, 많은 것을 얻을 수 없었습니다.누가 명확한 예를 들어 지적해 줄 수 있습니까?

@Documented메타 변환입니다.본인이 신청하세요@Documented주석을 정의할 때 주석을 사용하는 클래스가 생성된 JavaDoc에 이를 표시하도록 합니다.저는 그것을 많이 사용하는 것을 보지 못했지만, 여기에 예가 있습니다.이전 질문은 Eclipse에서 자동으로 작동하지 않는다는 것을 시사하지만, Eclipse 3.6에서 테스트를 수행했으며, 추가 여부에 관계없이 JavaDoc 팝업에 주석이 표시됩니다.@Documented그들에게 주석을 달았습니다.

다음은 트랜잭션 메서드가 JavaDoc에서 동일하게 표시되도록 하는 Spring의 예입니다.

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Transactional {

만약 우리의 주석이 있다면 (예를 들어,@InWork)는@Documented그러면 모든 학급이 그것을 가지고 있습니다.@InWorkjavadoc에 의해 생성된 텍스트에 포함될 주석@InWork주석에 대한 참조로 사용되는 텍스트입니다.

주석:

@Documented
@Inherited  // for descenders of the annotation to have the @Documented feature automatically
@Retention(RetentionPolicy.RUNTIME) // must be there
public @interface InWork {
    String value();
}

주석이 달린 대상:

/**
 * Annotated class.
 */
@InWork(value = "")
public class MainApp {...}

javadoc 텍스트:

따라서, 당신은 주석이 자바독 텍스트에 표시되어야 하는지 결정해야 하며, 만약 그렇다면, 설정해야 합니다.@Documented하게.

위의 정보는 Oracle 설명서에서 가져온 것입니다.

---

이클립스에서는 자바독 생성 텍스트에서 모든 주석을 볼 수 있습니다.@Documented,그렇지 않으면.

4.3 버전에 대해서는 여전히 정확합니다.

Java 튜토리얼에서 하나의 사용을 포함한 여러 표준 주석에 대한 예제와 더 많은 설명을 제공하는 유용한 페이지를 찾았습니다.@Documented특히 하단의 노트 블록에서 프리앰블 예제(섹션 문서)를 확인합니다.

언급URL : https://stackoverflow.com/questions/5592703/documented-annotation-in-java