Javadoc의 좋은 예

Javadoc을 포함 하는 소스 파일 의 좋은 예가 있습니까?

인터넷에서 Javadoc에 대한 좋은 예를 많이 찾을 수 있습니다 .Javadoc을 작성하는 데 사용되는 특정 구문을 찾고 싶습니다. 어딘가의 라이브러리 소스를 통해 구멍을 뚫을 수는 있지만 많은 작업처럼 보입니다.

JDK 소스 코드는 어떻습니까? docjar와 같은 타사를 통해 액세스합니까? 예를 들어, 콜렉션 소스 입니다.

그렇게하면 큰 다운로드가 없습니다.

Javadoc Tool 용 Doc Coments 작성 방법 페이지 에는 좋은 예가 많이 있습니다. 하나의 섹션 을 문서 주석의 예 라고하며 사용법이 많이 들어 있습니다.

또한 Javadoc FAQ 에는 답변을 설명하기위한 추가 예제가 포함되어 있습니다.

방법에 대한 JDK의 소스 코드?

작은 문서 패턴 세트를 사용합니다.

• 스레드 안전성에 대해 항상 문서화
• 항상 불변성을 문서화
• 예제가있는 javadoc ( 포맷터 와 같은 )
• 주석이 달린 요소를 대체하기 위해 WHY 및 HOW로 @Deprecation

Spring 프레임 워크 소스를 살펴보면 훌륭한 javadoc이 있습니다.

예를 들어 ANT-온라인으로 검색 가능한 소스 코드 : http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

다른 파일을 선택하려면 다음 사이트 에서 시작 하십시오 . http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

Lucene 의 출처를 다운로드하여 어떻게하는지보십시오. 그들은 좋은 JavaDoc을 가지고 있습니다.

Eclipse 를 사용하는 경우 Installed JREs 에서 JDK ( JRE 아님)를 설정 한 다음 Open Type ( + + ) 을 사용하여 다음과 같이 지정할 수 있습니다.CtrlShiftTjava.util.Collections

Google Guava의 EventBus 패키지 및 클래스 문서 는 Javadoc의 좋은 예입니다. 특히 빠른 시작과 함께 패키지 설명서가 잘 작성되었습니다.

JDK를 설치하고 소스도 설치하도록 선택한 경우 src.zip에는 모든 공용 Java 클래스의 소스가 포함됩니다. 이것들 대부분은 꽤 좋은 javadoc을 가지고 있습니다.

원하는 모든 구문이 구문 인 경우 다음이 도움이 될 수 있습니다.

Javadoc 도구에 대한 문서 주석 작성 방법