이 API 문서의 구성 방법
-
개요
개요 페이지는 이 API 문서의 첫 페이지로, 모든 패키지 목록과 각 패키지에 대한 요약을 제공합니다. 이 페이지에는 패키지 세트에 대한 전체 설명도 포함될 수 있습니다.
-
패키지
각 패키지에는 해당 클래스 및 인터페이스 목록과 각각에 대한 요약이 포함된 페이지가 있습니다. 이러한 페이지에는 6개의 카테고리가 포함될 수 있습니다.
- 인터페이스
- 클래스
- Enums
- 예외
- 오류
- 주석 유형
-
클래스 또는 인터페이스
각 클래스, 인터페이스, 중첩 클래스 및 중첩 인터페이스에는 별도의 페이지가 있습니다. 각 페이지에는 클래스/인터페이스 설명, 요약 표 및 자세한 멤버 설명으로 구성된 세 개의 섹션이 있습니다.
- 클래스 상속 다이어그램
- 직접 서브클래스
- 알려진 모든 하위 인터페이스
- 알려진 모든 구현 클래스
- 클래스 또는 인터페이스 선언
- 클래스 또는 인터페이스 설명
- 중첩된 클래스 요약
- 필드 요약
- 속성 요약
- 생성자 요약
- 메서드 요약
- 필드 세부 정보
- 속성 세부 정보
- 생성자 세부 정보
- 메서드 세부 정보
각 요약 항목에는 해당 항목에 대한 자세한 설명의 첫 번째 문장이 포함되어 있습니다. 요약 항목은 알파벳순이며 자세한 설명은 소스 코드에 표시되는 순서대로 표시됩니다. 이렇게 하면 개발자가 설정한 논리적 그룹이 보존됩니다.
-
주석 유형
각 주석 유형에는 다음 섹션이 포함된 별도의 페이지가 있습니다.
- 주석 유형 선언
- 주석 유형 설명
- 필수 요소 요약
- 선택적 요소 요약
- 요소 세부 정보
-
열거형
각 열거형에는 다음 섹션이 있는 별도의 페이지가 있습니다.
- 열거형 선언
- 열거형 설명
- 열거형 상수 요약
- 열거형 상수 세부 정보
-
트리(클래스 계층 구조)
모든 패키지에 대한 클래스 계층 구조 페이지와 각 패키지에 대한 계층 구조가 있습니다. 각 계층 구조 페이지에는 클래스 목록과 인터페이스 목록이 포함되어 있습니다. 클래스는
java.lang.Object로 시작하는 상속 구조로 구성됩니다. 인터페이스가java.lang.Object에서 상속되지 않습니다.- 개요 페이지에서 '트리'를 클릭하면 모든 패키지에 대한 계층 구조가 표시됩니다.
- 특정 패키지, 클래스 또는 인터페이스 페이지를 볼 때 "트리"를 클릭하면 해당 패키지에 대한 계층 구조만 표시됩니다.
-
사용되지 않는 API
사용 중단된 API 페이지에는 사용 중단된 모든 API가 나열됩니다. 일반적으로 개선을 위해 사용되지 않는 API는 사용하지 않는 것이 권장되며, 일반적으로 대체 API가 제공됩니다. 더 이상 사용되지 않는 API는 향후 구현에서 제거될 수 있습니다.
-
Index
인덱스 에는 모든 클래스, 인터페이스, 생성자, 메서드 및 필드에 대한 알파벳순 인덱스와 모든 패키지 및 모든 클래스의 목록이 포함되어 있습니다.
-
모든 클래스
모든 클래스 링크에는 비정적 중첩 유형을 제외한 모든 클래스와 인터페이스가 표시됩니다.
-
직렬화된 양식
직렬화 가능 또는 외부화 가능 클래스에는 직렬화 필드 및 메서드에 대한 설명이 있습니다. 이 정보는 API를 사용하는 개발자가 아닌 다시 구현하는 사람들의 관심 대상입니다. 탐색 모음에 링크가 없지만 직렬화된 클래스로 이동하여 클래스 설명의 "참고 항목" 섹션에 있는 "직렬화된 양식"을 클릭하면 이 정보를 얻을 수 있습니다.
-
상수 필드 값
상수 필드 값 페이지에는 정적 최종 필드와 해당 값이 나열됩니다.
-
검색
이름의 일부 또는 전부를 사용하여 API에 정의된 모듈, 패키지, 유형, 필드, 메서드 및 기타 용어의 정의를 검색할 수 있습니다. '카멜 케이스' 약어가 지원됩니다. 예를 들어 'InpStr'은 'InputStream' 및 'InputStreamReader'를 찾습니다.
이 도움말 파일은 표준 doclet에서 생성된 API 문서에 적용됩니다.