API 설명서 구성 방법

이 API (Application Programming Interface) 설명서는 다음에서 설명하는 것처럼 이동 표시줄의 항목에 해당되는 페이지가 있습니다.

개요

API 설명서의 첫 페이지 개요에서는 각 패키지에 대한 간단한 요약과 함께 모든 패키지의 목록을 제공합니다. 또한, 이 페이지는 패키지 집합에 대한 전체적인 설명도 포함합니다.

패키지

각 패키지는 각 클래스와 인터페이스에 대한 간단한 요약과 함께 각 페이지의 클래스 및 인터페이스 목록을 포함하는 페이지가 있습니다. 이 페이지에는 4개의 범주가 있습니다.

• 인터페이스(기울임꼴)
• 클래스
• 예외
• 오류

클래스/인터페이스

각 클래스, 인터페이스, 내부 클래스 및 내부 인터페이스는 별도의 페이지로 되어 있습니다. 각 페이지에는 클래스/인터페이스 설명, 요약 표 및 자세한 구성원 설명으로 구성된 3 개의 절이 있습니다.

• 클래스 상속 다이어그램
• 직접 서브 클래스
• 알려진 모든 서브 인터페이스
• 알려진 모든 구현 클래스
• 클래스/인터페이스 선언
• 클래스/인터페이스 설명

• 내부 클래스 요약
• 필드 요약
• 구성자 요약
• 메소드 요약

• 필드 세부 사항
• 구성자 세부 사항
• 메소드 세부 사항

각 요약 항목은 해당 항목에 대한 세부 설명의 첫 문장을 포함합니다. 요약 항목은 사전순으로 되어 있고, 세부 설명은 소스 코드에 나타나는 순서로 되어 있습니다. 이렇게 하여 프로그래머가 설정한 논리적 그룹을 유지합니다.

사용

각 문서화된 클래스 및 인터페이스 패키지에는 고유의 사용 페이지가 있습니다. 이 페이지는 어떤 패키지, 클래스, 메소드, 구성자 및 필드가 지정된 클래스 또는 패키지를 사용하는지 설명합니다. 지정된 클래스 A 또는 인터페이스 A의 사용 페이지는 A의 서브 클래스, A로 선언된 필드, A를 반환하는 메소드 및 A 유형의 매개 변수를 가진 구성자를 포함합니다. 이 페이지에 액세스하려면 먼저 패키지, 클래스 또는 인터페이스로 이동한 다음 이동 표시줄에 있는 "사용" 링크를 누릅니다.

트리(클래스 계층)

모든 패키지에는 클래스 계층 페이지가 있고 각 패키지에 대한 계층이 있습니다. 각 계층 페이지에는 클래스 및 인터페이스 목록이 있습니다. 클래스는 java.lang.Object로 시작하는 상속 구조로 구성됩니다. 인터페이스는 java.lang.Object에서 상속하지 않습니다.

• 개요 페이지를 볼 때 "트리"를 누르면 모든 패키지의 계층이 표시됩니다.
• 특정 패키지, 클래스 또는 인터페이스 페이지를 볼 때 "트리"를 누르면 해당 패키지의 계층만 표시합니다.

불안정한 API

불안정한 API 페이지는 사용하지 않는 모든 API를 나열합니다. 보통 기능이 개선되거나 대체 API를 제공하므로 불안정한 API는 사용하지 않는 것이 좋습니다. 불안정한 API는 향후 구현에서 제거할 수 있습니다.

색인

색인은 모든 클래스, 인터페이스, 구성자, 메소드 및 필드의 사전순 목록을 포함합니다.

이전/다음

이 링크는 다음 또는 이전 클래스, 인터페이스, 패키지 또는 관련된 페이지로 이동해줍니다.

프레임/프레임 없음

이 링크는 HTML 프레임을 보여주거나 숨깁니다. 모든 페이지는 프레임 형태로 또는 프레임 없이 볼 수 있습니다.

일련화된 양식

각 직렬화 또는 구체화 가능한 클래스에는 해당 직렬화 필드 및 메소드에 대한 설명이 있습니다. 이 정보는 API를 사용하는 개발자가 아닌 재 구현자에게 필요한 정보입니다. 이동 표시줄에는 링크가 없지만 직렬화된 클래스로 이동하여 "참고 항목"의 "직렬화 형식"을 누르면 관련 정보를 볼 수 있습니다.

This help file applies to API documentation generated using the standard doclet.