Java 설명서는 어떻게 읽습니까?

Question

나는 다양한 패키지 클래스와 자바 메소드에 대한 온라인 문서를 읽는 방법에 대한 조언을 찾고있다.

내가이 모든 물건을 의미 : http://java.sun.com/javase/6/docs/api/

Answer 1

Here's a tutorial.

실제로 필요할 때만 읽으십시오. 남은자를 위해 자습서를 살펴보십시오. 일반적으로 "[키워드] 자습서 사이트 : oracle.com"검색 결과가 충분합니다.

업데이트은 당신이 자바 독을 찾으려면하는 예로서 다음 걸릴 :

someString.split("\\."); 

다음

someString이 java.lang.String의 인스턴스입니다. API documentation root ()에서 시작하기를 원한다고 가정 할 때 Firefox의 주소 표시 줄에 "java.lang.string javase api site : oracle.com"을 입력하는 편이 낫습니다. 그리고 브라우저 기록에 아직 가지고 있지 않다.) 또는으로 메인 프레임을 스크롤하고 java.lang package으로 스크롤 한 다음 링크 요약을 클릭하면 클래스 요약에서 String class을 확인하고 링크를 클릭하면, 방법 요약에서 split() method을 확인하고 링크를 클릭하십시오.

자바 SE API의 자바 독은 간결하지만 꽤 완료되고 당신이 그들을 것으로 예상 다른 JavaDoc을 링크를 제공합니다. 예를 들어, String#split()의 javadoc의 하단에 당신은 차례로 그 클래스에서 정규식 물건 '도입을 설명 Pattern 클래스에 "참조"링크를 참조하십시오.

Answer 2

그것이 을 필요에 따라 읽기. 에서처럼 프로젝트의 맥락에서. 문서화는 주로 개념 형식을 가르치는 것이 아니라 필요 기반 형식입니다.

예를 들어 SDK를 배우려면 무언가를 읽고 싶다면 교과서를 읽으십시오.

Answer 3

JavaDoc은 단지 참조 용 일뿐입니다. "이게 (클래스/메소드)는 무엇을 하는가?"라는 질문에 답하기에 좋습니다. 다만 다른 것에 대해서는 끔찍한 것입니다. 당신은 JavaDoc을 혼동하는 경우

, 당신은 책을 선택하거나 온라인 자습서를 찾아야한다. 특정 질문에만 답하기 위해이 설명서를 참고 자료로 사용하십시오. 혼란스럽지 않을 것입니다.

Answer 4

문자열이 있다고 가정하면 대문자로 변환하는 방법을 알아 내려고합니다. http://java.sun.com/javase/6/docs/api/java/lang/String.html 에서, 문자열에 대한 javadoc에 봐 (또는 위의 링크에서 바로 왼쪽 목록에서 문자열을 찾을 수 아래로 스크롤합니다.

을 당신이하는 방법이있다 toUpperCase()라고 볼 수 있습니다. 당신은 그것을 클릭 할 수 있습니다 자세한 내용을 찾으십시오. 그러면 문자열에 "할 수있는"일을 설명하는 다른 모든 메서드가 표시됩니다.

그리고 생성자 목록도 있습니다. 문자열 객체를 생성하십시오.

문자열이 너무 어렵지 않으므로 좀 더 복잡한 것을 시도해보십시오 : 어떻게 BufferedOutputStream을 생성합니까?

Answer 5

javadoc을 iTunes에서 찾아보기 앨범으로 생각해보십시오. 상단 왼쪽 프레임은 패키지 목록입니다. 그게 전부 예술가 목록처럼. 그 중 하나를 선택하면 왼쪽 하단 프레임에 표시된 내용이 변경됩니다. 왼쪽 하단 프레임은 위에 선택된 패키지의 클래스/인터페이스 목록입니다. 그게 바로 아티스트를 선택하고 앨범 목록을 보여주는 것과 같습니다. 그런 다음 클래스/인터페이스 중 하나를 선택할 수 있으며 세부적인보기가 기본 프레임에 나타납니다. 선택한 앨범의 트랙 목록과 비슷합니다.

메인 프레임 세부 정보는 그 클래스 또는 인터페이스와 상호 작용하는 데 필요한 공개 정보와 보호 된 정보를 모두 표시합니다. 상단에는 상속 계층 구조와 클래스에 대한 설명이 표시됩니다. 아래는 클래스에 공개되거나 보호 된 모든 필드, 생성자 및 메서드에 대한 요약입니다. 그 중 하나의 링크를 클릭하면 전체 설명으로 이동할 수 있습니다. 요약의 맨 아래에는 상속 된 모든 메소드 목록이 있습니다.

인수 또는 반환 유형과 같은 javadoc에서 참조되는 모든 클래스는 링크입니다. 링크를 클릭하면 해당 클래스의 javadoc으로 이동합니다. 이런 식으로 진행되는 일을 파악하는 데 필요한 모든 클래스를 탐색하기가 쉽습니다. 정확히는 아니지만 작동합니다. html이기 때문에 새 탭에서 링크를 열 수도 있습니다. 따라서 모든 관련 클래스를 한 번에 쉽게 열 수 있습니다.

마지막 팁 하나 - 세부 정보 창의 맨 위에 몇 가지 추가 옵션이 있습니다. 내가 많이 사용하는 프레임은 프레임/프레임 없음 링크입니다. 이렇게하면 패키지와 클래스 프레임이 왼쪽에 추가되거나 제거됩니다. 새 탭에서 다른 클래스를 열거 나 Google을 사용하여 클래스를 찾으면 추가 프레임이없는 페이지가 표시됩니다. 프레임 태그를 클릭하면 페이지에 추가됩니다.

Answer 6

자바 SE API를 배우는 데 가장 도움이되는 점은 "The Java Tutorials"입니다. JavaDocs보다 훨씬 조직적인 방식으로 Java SE 전체를 거의 다룹니다. 관심있는 비트를 읽은 후에는 JavaDocs가 더 이해할 수 있습니다.

보통 IDE를 통해 관심있는 비트에 대한 JavaDocs를 읽습니다. Netbeans는 코드 완성의 일부로 JavaDoc을 자동으로 표시합니다. 그런 식으로, 나는 부분적으로 클래스 나 메소드 이름을 입력하여 사용할 생각을하고, JavaDocs에서 원하는 것을 찾을 때까지 찾아 볼 수있다.

Answer 7

나는 위의 모든 혼란스러운 사용자들입니다. VB classic을 위해 Windows API를 사용하는 열렬한 배경에서 나온 나 자신에 관해서는 Java API가 깨닫지 못한다.

예, Java API는 자체에 대한 충분한 정보와 각 클래스의 기능 및 구조를 제공합니다. 하지만 개발 과정에서 유용하게 쓰이는 것은 솔루션과 사용 가능한 코드를 언급하는 것이 아니라 훨씬 많은 것을 막을 수 있습니다.

Java에 익숙하지 않은 사람이라면 어떤 기능이 모든 패키지의 일부인지 기억하거나 기억할 수 없다고 생각하십시오. 그런 다음 메서드, 함수, 클래스 또는 이미 정의 된 용어를 찾는 것은 악몽입니다.

자바의 API 워드 프로세서에 관해서 : 이것은 환경과 언어에 따라 매우 다르다. 그것은 초보자의 눈을 감추지 만 단순히 다른 것에 집중할 때 완전히 다른 볼 게임입니다.

Java의 혼란스러워 진 API 문서 레이아웃을 대대적으로 개편하여 코딩을 시작하는 단계를 사람들이 알게 될 것입니다.