자바의 API 문서를 만드는 방법 - 더미

옛날 사람들은 문법적 기능만으로 프로그래밍 언어 (Java 포함)를 판단했습니다. if 문이 예상 한대로 수행합니까? 루핑 문은 사용하기가 쉽습니까? 효과적인 방법 구현?

요즘은 상황이 조금 다릅니다. Java는 문법적 기능의 전체 콜렉션을 가지고 있지만 Java는 단지 많은 문법 규칙 그 이상입니다. Java는 표준 Appl Programming Programming Interface 가 있습니다. 4,000 개 이상의 클래스로 구성된 거대한 라이브러리로, 각각 자체 기능, 자체 제한 사항 및 효과적인 사용을위한 자체 규칙이 있습니다.

용어 검색

API 문서에서 여러 가지 방법으로 항목을 찾을 수 있습니다. 각 방법은 한 상황에서 편리합니다. 예를 들어 Java에는 System이라는 메소드가 있습니다. 아웃. println. 다음은 시스템을 찾는 두 가지 방법을 설명합니다. 아웃. println 메소드.

색인 사용하기

다음은 시스템과 같은 것을 찾는 방법입니다. 아웃. println: 색인을 사용하여:

방문 문서. 신탁. com / javase / 8 / docs / api /.
-
그림 1과 같이 페이지 상단의 INDEX 링크를 클릭하여 색인을 엽니 다.

그림 1: API 문서의 기본 페이지.
글자 목록은 색인 상단에 있습니다 (그림 2 참조). P 링크를 클릭하여 println이있는 섹션으로 이동하십시오.

">
그림 2: API 문서의 색인 페이지.
P 섹션에서 println을 검색하여 println 항목을 찾습니다.

대부분의 웹 브라우저를 사용하면 페이지 텍스트에서 println과 같은 것을 검색 할 수 있습니다. 방법은 다음과 같습니다.
1. 브라우저가 큰 프레임에서 페이지의 대부분을 차지하고 (페이지의 왼쪽에있는 작은 프레임이 아닌) 검색하려고한다는 것을 알고 있는지 확인하십시오. 이렇게하려면 큰 프레임 안에서 마우스를 클릭하십시오. (링크를 클릭하지 마십시오. 프레임의 일부 중성 색 흰색 영역을 클릭하십시오.)
2. 브라우저의 찾기 대화 상자를 엽니 다. 대부분의 Windows 브라우저에서 Ctrl + F를 누르면 찾기 대화 상자가 숨겨집니다. Mac에서는 Command + F를 클릭하면됩니다.
3. 찾기 대화 상자가 나타나면 텍스트 상자에 println을 입력하고 상자에서 찾기 또는 다음 찾기 단추를 클릭하십시오.
println 항목 중 하나를 선택하십시오.

P 섹션은 아래 그림 3과 같이 println 항목이 많습니다. 항목은 두 가지 f}으로 서로 다 (니다.
- 각 항목은 println (int), println (String) 또는 println (someOtherTypeName)입니다. 유형 이름은 항목마다 다를 수 있습니다.
- 각 항목은 println이 java 클래스의 메소드임을 나타냅니다. someStuff. someMoreStuff . 클래스는 항목마다 다를 수 있습니다. API 문서 색인의
  
  println 항목 ">
  그림 3: API 문서 색인에서 일부 println 항목.
이 시점에서, 그것은 주위에 찌르는 것을 지불합니다. "Hello world!"와 같은 것을 인쇄하려고한다면! ", println (String) 항목 중 하나를 원합니다. 반면에 lengthOfStraightLine의 값을 인쇄하려고한다면 아마도 println (double) 항목을 선택하게 될 것입니다.

println (String)을 결정했다고 가정 해 보겠습니다. 3 개의 println (String) 항목 중에서 선택할 수 있습니다. 하나는 클래스 java에서 메소드라고합니다. io. PrintStream, 다음은 java 클래스의 메소드입니다. io. PrintWriter이며, 세 번째 클래스는 java 클래스의 메소드입니다. SQL. DriverManager. 다음 세 가지 항목 중 선택하시는 항목은 무엇입니까?

글쎄, 당신이 정말로 부르려고하는 것은 시스템이라는 것입니다. 아웃. println. Systemout을 사용하여 전체 lookup rigmarole을 살펴 본다면 해당 시스템을 찾을 수 있습니다. 출력에는 PrintStream 유형이 있습니다. (이하의 그림 4를 참조). 따라서, 선택하는 println (String) 엔트리는

println (String) - java 클래스의 메소드 io. PrintStream.

out 변수에는 PrintStream 유형이 있습니다. ">
그림 4: out 변수에는 PrintStream 유형이 있습니다.
선택한 항목의 링크를 클릭하십시오.

println (String) 링크를 클릭하면 브라우저는 그림 5와 같이 println 메소드를 설명하는 페이지로 이동합니다.이 페이지는 println이 수행하는 작업 ("Print an String and then …")과 String에 대한 문서가있는 페이지와 같은 다른 유용한 페이지를 가리 킵니다.

println 메소드. ">
그림 5: println 메소드에 대한 설명.

클래스 목록 사용

클래스 목록에서 시작하여 API 항목을 찾는 방법은 다음과 같습니다.

방문 문서. 신탁. com / javase / 8 / docs / api /.
System 클래스를 설명하는 페이지를 찾습니다.

시스템에 대해 설명하는 문서를 찾고 있습니다. 아웃. println. 그래서 당신은 시스템을 찾아보고, 밖으로 나아가고, 거기에서 println으로 나아가십시오.

시스템에 대한 링크를 찾으려면 페이지 왼쪽의 하단 프레임을보십시오. (그림 6 참조) 페이지에서 텍스트를 찾는 방법은 "색인 사용"섹션의 3 단계를 참조하십시오.

시스템 클래스. ">
그림 6: System 클래스에 대한 링크 찾기.
시스템 링크를 클릭하면 그림 7과 같이 브라우저가 System 클래스의 문서 페이지를 표시합니다.

System 클래스 설명서. ">
그림 7: System 클래스의 문서.
System 클래스의 문서 페이지에서 out 변수를 찾습니다.

웹 브라우저의 찾기 대화 상자를 사용하는 경우 다음 찾기 버튼을 여러 번 클릭해야합니다. (이름은 너무 일반적이므로 시스템 문서 페이지의 몇 가지 다른 상황에서 여러 번 나타납니다.) 원하는 것을 찾으면 위의 그림 4와 같은 테이블을 볼 수 있습니다.
테이블의 바깥 쪽 행에서 PrintStream 링크를 클릭합니다.

문서에 따르면 out 변수는 PrintStream 유형의 객체를 참조합니다.즉, println은 PrintStream 클래스의 일부입니다. 그것이 PrintStream 링크를 클릭하는 이유입니다.
PrintStream의 문서 페이지에서 println (String)을 찾으십시오.

위의 그림 5와 같은 설명을 볼 수 있습니다.

당신도 할 수 있습니다.

이 기사의 단계를 수행 한 후에, "대박! API 문서에서 println을 찾을 수는 있지만 다른 것을 찾을 수는 없습니다. 그리고 사람들이 독자적으로 프로그래밍하는 내용의 설명서를 만들면 표준 API 설명서처럼 보이지 않게됩니다. 나는 개울이 될거야. "

그러한 반대에 대한 적절한 대답은"말도 안돼! 실없는 소리! 발데 대시! 말 깃털! "이유는 다음과 같습니다.

이 기사의 단계별 지침에는 표준 Java 설명서에서 필요한 것을 찾는 데 필요한 대부분의 트릭이 나와 있습니다. 시스템을 찾을 수 있다면. 아웃. println, javax. 그네. JButton 또는 표준 Java API에있는 4,200 개의 프로그램 중 하나.

그리고 Java, 클래스, 메소드 및 변수 간의 관계에 대해 더 많이 알게되면이 기사의 단계별 지침이 훨씬 자연스러워집니다.
다른 사람의 문서를 읽는 경우 목록에서 바로 문제를 긁을 수 있습니다. 표준 API 문서는 직접 입력하지 않았습니다. 이들은 실제 Java 프로그램 코드에서 자동으로 생성되었습니다. 예를 들어 PrintStream의 코드입니다. java에는 다음과 같은 몇 줄이 있습니다.
```
/ ** * String을 출력 한 다음 줄을 끝내십시오. *이 메소드는 *

{@ link #print (String)}

*와

{@ link # println ()}

를 호출하는 것처럼 동작합니다. * * @param x 인쇄 할

String

. * /
```
API 문서를 작성하기 위해 Java 지휘관이 javadoc 라는 프로그램을 실행했습니다. javadoc 프로그램은 PrintStream에서 바로 이러한 행을 가져 왔습니다. java 파일을 편집하고 라인을 사용하여 웹 브라우저에 표시되는 문서를 작성하십시오.

다른 자바 프로그래머도 똑같은 일을합니다. 실제로 Java 코드를 작성하는 모든 사람은 javadoc 프로그램을 사용하여 문서를 생성합니다. 따라서 모든 사람의 Java 설명서는 다른 모든 사람의 Java 설명서와 유사합니다. 표준 API 문서를 읽는 방법을 알면 누구든지 자체 개발 한 Java 문서를 읽는 방법을 알게됩니다.

그리고 네, javadoc 프로그램을 사용하여 자신의 문서를 만들 수 있습니다. JDK를 다운로드하면 javadoc 프로그램이 거래의 일부로 사용됩니다.