자바의 @Documented 주석

자바의 @Documented 주석

---

@DocumentedJava에서 주석 의 목적은 무엇입니까 ?

나는 문서를 보았지만 그것으로부터 많은 것을 얻을 수 없었다. 누군가가 명확한 예의 도움으로 지적 할 수 있습니까?

---

@Documented메타 주석입니다. @Documented어노테이션을 정의 할 때 적용 하여 어노테이션을 사용하는 클래스가 생성 된 JavaDoc에이를 표시하도록합니다. 나는 그것을 많이 사용하지 않았지만 여기에 예가 있습니다 . 이전 질문은 Eclipse 에서 자동으로 작동하지 않는다고 제안 하지만 Eclipse 3.6에서 테스트했으며 @Documented주석을 첨부했는지 여부에 관계없이 JavaDoc 팝업에 주석이 나타납니다 .

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

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

---

(예를 들어, 일부 우리의 주석이있는 경우 @InWork)는 @Documented, 그 가진 모든 클래스에 대한 @InWork주석 javadoc에 의해 생성 된 텍스트가 포함됩니다 @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 텍스트 :

따라서 주석이 javadoc 텍스트에 표시되어야하는지 여부를 결정하고 예인 경우 @Documented이를 설정 해야합니다.

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

---

Eclipse에서는 javadoc 생성 텍스트에서 모든 주석을 볼 수 있습니다 @Documented.

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

---

Java Tutorials 에서 유용한 페이지를 찾았습니다.이 페이지는 .NET의 한 가지 사용을 포함하여 여러 표준 주석에 대한 예제와 자세한 설명을 제공합니다 @Documented. 특히, Preamble 예제에 대한 하단 의 Note 블록을 보십시오 ( Documentation 섹션 ).

참고 URL : https://stackoverflow.com/questions/5592703/documented-annotation-in-java