2011-02-08 5 views
0

저는 일부 코드에서 Checkstyle을 실행 해 왔으며 특정 목적을 위해 주석을 추가하는 방법에 대한 좋은 예를 찾고 있습니다.Javadoc 주석이있는 Java 코드의 좋은 예를 찾으십시오.

예를 들어 Checkstyle은 상수/클래스 변수에 대한 설명을 추가해야한다고 말합니다. 공식적인 오라클 호스트 어디에도이 예제를 찾을 수 있습니까? 나는 소스 코드 내 손에 얻을 수 있다면

나는 다양한 장소에서 찾고, 그러나 간결한 예를 찾을 수 없습니다 ... 1 2 3 4 5 나는 생각 Java Calendar 클래스의 경우 좋은 예가 될 것입니다. 해당 클래스의 API 문서에서 모든 종류의 상수를 볼 수 있습니다.

here을 참조하십시오.

어떻게 수 I 중 하나를

1) 달력의 소스에 손을 가져 오기?

2)의 Javadoc에 다음과 같은 코드를 문서화하는 것 방법의 예를 찾기 (Checkstyle 플래그 그것을 필요) : "추가 자료"에서

Java 6 download page private static final int NO_OF_RECORDS = 10;

+1

와우,'java.util.Calendar'는 한번 좋은 예제로 인용되고 있습니다 ... –

+0

이것은 스택 오버 플로우 버그입니다! 이드는 빤다! – JGFMK

답변

3

, 섹션에서 전체 JDK의 소스 코드를 다운로드 할 수있다.

또한 대부분의 IDE는 Java 라이브러리 클래스의 소스 코드를 자동으로 색인화하여 해당 클래스를 투명하게 열 수 있습니다.

+0

내 기억을 조깅 해 줘서 고마워. 원하는 경우 IDE 외부에서 압축을 풀고 볼 수있는 src.jar 파일이 있습니다 (적어도 1.6.6/10.6.6까지 Snow Leapard에 있었음). 설치 직후와 소프트웨어 업데이트를 실행하기 전에 사본을 확보했습니다. 나는 그것에 대해 모든 것을 잊어 버렸다! :-) – JGFMK

관련 문제