Làm cách nào để đọc tài liệu java?

Question

Tôi đang tìm một số lời khuyên về cách đọc về tài liệu trực tuyến về các lớp gói và phương thức khác nhau cho java.

tôi có nghĩa là tất cả các công cụ này: http://java.sun.com/javase/6/docs/api/

Answer 1

Here's a tutorial.

Và thực sự, chỉ đọc khi cần. Đối với phần còn lại, đi qua một hướng dẫn. Thông thường, "trang web hướng dẫn [từ khóa] của Googling: oracle.com" mang lại kết quả đủ.

Cập nhật để lấy sau làm ví dụ mà bạn muốn tìm Javadoc:

someString.split("\\."); 

Đây someString là một thể hiện của java.lang.String. Giả sử bạn muốn tự mình bắt đầu từ số API documentation root (bản thân mình, tôi thích chỉ gõ "java.lang.string javase api site: oracle.com" trong thanh địa chỉ của Firefox để có được nó thẳng cho tôi (nếu bạn cảm thấy may mắn và chưa có trong lịch sử trình duyệt), hoặc chỉ cần kiểm tra trong IDE), sau đó cuộn trong khung chính đến java.lang package và nhấp vào liên kết, sau đó trong tóm tắt lớp hãy kiểm tra String class và nhấp vào liên kết, sau đó trong tóm tắt phương pháp, hãy kiểm tra split() method và nhấp vào liên kết.

Javadoc của API Java SE là súc tích, nhưng khá hoàn chỉnh và cung cấp liên kết đến các javadocs khác mà bạn mong đợi. Ví dụ: ở dưới cùng của String#split() javadoc, bạn sẽ thấy liên kết "Xem thêm" với lớp Pattern, từ đó giải thích rằng công cụ regex trong phần giới thiệu của lớp.

Answer 2

đọc nó khi cần thiết . Như trong, trong bối cảnh của một dự án. Tài liệu phần lớn là một định dạng dựa trên nhu cầu, không phải là một định dạng giảng dạy khái niệm.

Nếu không, nếu bạn muốn thực sự hãy đọc điều gì đó để tìm hiểu SDK chẳng hạn, hãy đọc sách hướng dẫn.

Answer 3

JavaDoc chỉ là một tham chiếu. Thật tuyệt vời khi trả lời câu hỏi về biểu mẫu "điều này (lớp/phương pháp) làm gì?" nhưng thật khủng khiếp vì mọi thứ khác.

Nếu bạn bị nhầm lẫn bởi JavaDoc, bạn nên chọn một cuốn sách hoặc tìm một hướng dẫn trực tuyến. Sử dụng tài liệu làm tài liệu tham khảo để chỉ trả lời các câu hỏi cụ thể và có thể bạn sẽ không bị nhầm lẫn.

Answer 4

Hãy tưởng tượng rằng bạn có một Chuỗi và bạn đang cố gắng tìm ra cách chuyển đổi thành chữ hoa. Nhìn vào javadoc cho String, tại http://java.sun.com/javase/6/docs/api/java/lang/String.html (hoặc từ liên kết của bạn trên, chỉ cần cuộn xuống để tìm String trong danh sách dưới bên trái.

Bạn sẽ tìm thấy có một phương pháp có tên là toUpperCase(). Bạn có thể click vào nó để Và bạn sẽ thấy tất cả các phương pháp khác ở đó, mô tả những thứ bạn có thể "làm" cho một Chuỗi.

Và có một danh sách các nhà thầu, cho bạn biết cách bạn có thể " tạo một đối tượng chuỗi

Có thể nó không quá khó đối với một String, vì vậy hãy thử một cái gì đó phức tạp hơn: Làm thế nào để bạn tạo một BufferedOutputStream?

Answer 5

Hãy tưởng tượng javadoc là duyệt album trong itunes. Khung trên cùng bên trái là danh sách các gói. Thats như một danh sách các nghệ sĩ. Chọn một trong những thay đổi được hiển thị ở khung bên trái phía dưới. Khung dưới cùng bên trái là danh sách các Lớp/Giao diện trong gói được chọn ở trên nó. Thats như chọn một nghệ sĩ và hiển thị danh sách các album. Sau đó bạn có thể chọn một trong các lớp/giao diện và giao diện chi tiết của nó sẽ xuất hiện trong khung chính. Thats giống như danh sách bài hát cho album đã chọn.

Tương tự với ITunes sang một bên, chi tiết khung chính hiển thị tất cả thông tin công khai và được bảo vệ cần thiết để tương tác với lớp hoặc giao diện đó. Ở phía trên nó hiển thị hệ thống phân cấp thừa kế và mô tả của lớp. Dưới đây là tóm tắt tất cả các trường, hàm tạo và phương thức được công khai hoặc được bảo vệ trên lớp. Bạn có thể nhấp vào liên kết trên bất kỳ hình thức nào trong số đó để chuyển đến mô tả đầy đủ. Ở cuối bản tóm tắt là danh sách tất cả các phương thức kế thừa.

Bất kỳ lớp nào được tham chiếu trong javadoc, chẳng hạn như đối số hoặc kiểu trả về sẽ là liên kết. Nếu bạn nhấp vào liên kết, nó sẽ điều hướng đến javadoc cho lớp đó. Bằng cách này là khá dễ dàng để điều hướng thông qua tất cả các lớp cần thiết để tìm ra những gì đang xảy ra. Nó không phải là chính xác, nhưng nó hoạt động. Là html, bạn thậm chí có thể mở liên kết trong một tab mới, và do đó dễ dàng mở tất cả các lớp liên quan cùng một lúc.

Một mẹo cuối cùng - có một số tùy chọn bổ sung ở đầu ngăn chi tiết. Một trong đó tôi sử dụng rất nhiều là các liên kết Frames/No Frames. Thao tác này sẽ thêm hoặc xóa khung gói và lớp ở bên trái. Nếu bạn mở các lớp khác trong các tab mới, hoặc đôi khi nếu bạn tìm thấy một lớp bằng cách sử dụng google, bạn sẽ bật lên trên một trang không có khung phụ. Chỉ cần nhấp vào thẻ Khung và chúng sẽ được thêm vào trang.

Answer 6

Điều hữu ích nhất đối với tôi khi học API Java SE là "The Java Tutorials". Nó bao gồm khá nhiều toàn bộ Java SE, theo cách được tổ chức hơn nhiều so với JavaDocs. Sau khi bạn đọc các bit bạn quan tâm, JavaDocs sẽ tự ý nghĩa hơn.

Thông thường tôi đọc JavaDocs cho các bit mà tôi quan tâm thông qua IDE. Tôi sử dụng Netbeans, nó tự động hiển thị JavaDoc như là một phần của việc hoàn thành mã của nó. Bằng cách đó, tôi có thể gõ một phần tên lớp hoặc tên phương thức mà tôi đang nghĩ đến việc sử dụng, và sau đó duyệt qua các JavaDocs của các đề xuất cho đến khi tôi tìm thấy những gì tôi muốn.

Answer 7

Tôi thứ hai tất cả những người dùng nhầm lẫn ở trên. Đối với bản thân mình đến từ một nền tảng avid của việc sử dụng Windows API cho VB cổ điển, Java API không phải là giác ngộ.

Vâng, API Java cung cấp thông tin phong phú về chính nó, những gì mỗi lớp làm và cấu trúc của tất cả; nhưng, đối với bất cứ điều gì hữu ích trong quá trình phát triển, nó khá nhiều cản trở từ thay vì đề cập đến các giải pháp và mã có thể sử dụng được.

Hãy xem xét rằng bất kỳ ai mới sử dụng Java hầu như không thể nhớ lại hoặc ghi nhớ những chức năng nào là một phần của mỗi gói. Sau đó, để tìm một phương thức, hàm, lớp hoặc thuật ngữ đã định nghĩa được sử dụng là một cơn ác mộng.

Về tài liệu API của Java: Có một điều khác biệt và đặc biệt cụ thể đối với môi trường và ngôn ngữ; đó là một trò chơi bóng hoàn toàn khác khi nó tập trung hơn vào việc đơn giản là khác biệt mặc dù không mạch lạc với đôi mắt của người mới bắt đầu.

Tôi tin rằng mọi người sẽ tìm thấy các bước để bắt đầu viết mã đơn giản hóa nhiều bằng cách sửa đổi lớn bố cục tài liệu API không được tổ chức của Java.