Javadoc의 좋은 예


140

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

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

답변:


118

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

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


1
Josh와 Neal이 저술 한 컬렉션 이후의 좋은 답변입니다.
cherouvim

내 바이러스 백신 소프트웨어에 docjar 링크가 안전하지 않다고 말합니다. 컬렉션 소스를 제공하는 다른 웹 사이트를 알고 있습니까? (나는 :)이 상당히 높은 트래픽이 질문 아니었다면 그것은 슬라이드하자 것
고든 구스타프손

2
Windows에서 JDK 설치에는 src.zip표준 라이브러리의 소스 코드 가있는 파일이 포함 됩니다.
스리 Harsha Chilakapati

제 3자가 저작권이있는 코드를 배포하는 것은 어떻게 합법적입니까? 아니면 저작권이 허용합니까?
ThePyroEagle

이것은 외부 링크 "Docjar.net이 모두에게 다운되었습니다"의 주요 문제점입니다.
제우스의 책


9

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


그것은 내 명백한 생각 이었지만 전체 큰 혼란을 다운로드해야했습니다. :-(
Jason S

5
JDK와 함께 제공되므로 이미 설치되어있을 가능성이 있습니다 (설치 옵션 임).
Michael Borgwardt 's

5

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

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

더 이상 사용되지 않는 thx를 대체하는 방법을 포함하는 훌륭한 힌트
Tobi Tiggers



2

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


2

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


1
말한 것에 추가하기 위해, 대부분의 IDE는 사용할 JDK를 구성 할 때 javadoc 및 소스를 자동으로 구성합니다. Eclipse에만 적용되는 것은 아닙니다.
ThePyroEagle

2

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


1

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


당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.