Javadoc의 좋은 예 [폐쇄

Question

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

인터넷에서 javadoc의 좋은 예를 많이 찾을 수 있습니다. 나는 그것들을 만드는 데 사용되는 특정 구문을 찾고, 어딘가에 어떤 도서관의 출처를 통해 설득 할 수 있다고 가정하지만 많은 작업처럼 보입니다.

Answer 1

JDK 소스 코드는 어떻습니까? 그러나 Docjar와 같은 제 3자를 통해 액세스합니까? 예를 들어, 컬렉션 소스.

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

Answer 2

그 페이지 Javadoc 도구에 대한 문서를 작성하는 방법 좋은 예가 많이 포함되어 있습니다. 한 섹션이 호출됩니다 DOC 댓글의 예 그리고 몇 가지 사용법이 포함되어 있습니다.

또한, Javadoc FAQ 답을 설명하기위한 몇 가지 예제가 포함되어 있습니다.

Answer 3

어때 JDK 소스 코드?

Answer 4

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

• 항상 스레드 안전성에 대해 문서화합니다
• 항상 불변성을 문서화합니다
• 예제가있는 javadoc (좋아요 형성)
• 주석이 달린 요소를 교체하는 이유와 방법과 @deprecation

Answer 5

Spring Framework 소스를 살펴보면 우수한 Javadocs가 있습니다.

Answer 6

예를 들어 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

Answer 7

출처를 다운로드하십시오 루센 그리고 그들이 어떻게하는지보십시오. 그들은 좋은 Javadocs를 가지고 있습니다.

Answer 8

사용중인 경우 식, 당신은 당신의 설정을 설정할 수 있습니다 JDK (아니다 JRE) 안에 JRES를 설치했습니다, 그런 다음 사용합니다 오픈 유형 (Ctrl 키 + 옮기다 + 티),, 같은 것을주십시오 java.util.Collections

Answer 9

Google Guava의 문서 이벤트 버스 패키지와 수업은 Javadoc의 좋은 예입니다. 특히 빠른 시작이있는 패키지 문서는 잘 작성되었습니다.

Answer 10

JDK를 설치하고 소스를 설치하기로 선택한 경우 SRC.ZIP에는 모든 공개 Java 클래스의 출처가 포함되어 있습니다. 이들 대부분은 꽤 좋은 Javadoc을 가지고 있습니다.

Answer 11

당신이 찾는 것이 구문이라면, 이것은 도움이 될 수 있습니다.

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