Làm cho Tài liệu API của Sense of Java - những con vú

Ngày xưa, người đánh giá ngôn ngữ lập trình (bao gồm cả Java) chỉ bằng các tính năng ngữ pháp của họ. Liệu một tuyên bố nếu làm những gì bạn mong đợi nó để làm gì? Các câu lệnh lặp có dễ sử dụng không? Các phương pháp có được thực hiện có hiệu quả không?

Ngày nay, mọi thứ hơi khác một chút. Java có toàn bộ các tính năng ngữ pháp, nhưng Java không chỉ là một tập hợp lớn các quy tắc ngữ pháp. Java có một Appl ication Programming Interface -một thư viện khổng lồ bao gồm hơn 4,000 lớp, mỗi lớp có chức năng riêng, những hạn chế riêng của nó và các quy tắc riêng để sử dụng hiệu quả.

Tìm kiếm thuật ngữ

Bạn có thể tìm thấy mọi thứ trong tài liệu API theo một số cách khác nhau. Mỗi cách đều thuận tiện trong trường hợp này hoặc khác. Ví dụ, Java có một phương pháp có tên là System. ngoài. println. Điều sau đây mô tả hai cách để tra cứu Hệ thống. ngoài. phương pháp println.

Sử dụng chỉ mục

Dưới đây là cách tìm một cái gì đó, chẳng hạn như Hệ thống. ngoài. println, bằng cách sử dụng chỉ mục:

Truy cập tài liệu. oracle. com / javase / 8 / docs / api /.

Nhấp vào liên kết INDEX ở đầu trang để mở chỉ mục, như thể hiện trong hình 1.
Hình 1: Trang chính của tài liệu API.

Một danh sách các chữ cái nằm gần đầu của chỉ mục (xem hình 2). Nhấp vào liên kết P để đi đến phần với println trong đó.
">

hình 2: Trang chỉ mục tài liệu API.
Trong phần P, thực hiện tìm kiếm println để tìm các mục nhập inln.
Hầu hết các trình duyệt web cho phép bạn tìm kiếm một cái gì đó như println trong văn bản của một trang. Dưới đây là cách:

Đảm bảo rằng trình duyệt biết rằng bạn muốn tìm kiếm trong khung lớn chiếm hầu hết trang (chứ không phải trong các khung nhỏ hơn ở phía bên trái của trang). Để làm điều này, nhấp chuột vào bên trong khung lớn. (Đừng nhấp vào một liên kết Nhấp vào một số vùng trắng trung tính của khung)
1. Mở hộp thoại Tìm của trình duyệt. Trên hầu hết các trình duyệt Windows, nhấn Ctrl + F coaxes các hộp thoại Tìm ra khỏi ẩn. Trên máy Mac, nhấn vào Command + F.
2. Khi bạn thấy hộp thoại Tìm, nhập println vào hộp văn bản và nhấp vào nút Tìm hoặc Tìm Tiếp theo của hộp.
3. Chọn một trong các mục inln.
Phần P có khối lượng lớn các mục println, như thể hiện trong hình 3 bên dưới. Các mục nhập khác nhau theo hai cách:

Mỗi mục nói println (int), println (String), hoặc println (someOtherTypeName). Tên kiểu có thể khác với một mục nhập khác.
- Mỗi mục cho biết println là một phương thức trong lớp java.
- someStuff. someMoreStuff . Các lớp có thể khác nhau từ một mục khác. các mục println trong chỉ mục của tài liệu API. ">
  
  Hình 3: Một số mục println trong chỉ mục của tài liệu API.
  Tại thời điểm này, nó trả tiền để poke xung quanh. Nếu bạn đang cố in ra một thứ như "Xin chào thế giới! ", Bạn muốn một trong các mục println (String). Mặt khác, nếu bạn đang cố gắng để in giá trị của lengthOfStraightLine, bạn có thể chọn một mục nhập println (đôi).
Bây giờ, giả sử bạn đã quyết định về println (String). Bạn có thể chọn từ ba mục println (String). Một cho biết đó là một phương pháp trong lớp java. io. PrintStream, tiếp theo là một phương pháp trong lớp java. io. PrintWriter, và thứ ba là một phương pháp trong lớp java. sql. DriverManager. Bạn chọn ba mục nào?

Vâng, những gì bạn thực sự cố gọi là cái gì đó có tên System. ngoài. println. Nếu bạn đi qua toàn bộ tra cứu kết nối với Systemout, bạn sẽ thấy rằng Hệ thống. ra có loại PrintStream. Vì vậy mục println (String) bạn quyết định chọn là

println (String) - Phương thức trong lớp java. io. PrintStream.

ra biến có kiểu PrintStream. ">

Hình 4: Biến ngoài có kiểu PrintStream.
Nhấp vào liên kết cho mục bạn đã chọn.
Khi bạn nhấn vào liên kết println (String), trình duyệt sẽ đưa bạn đến trang giải thích một phương pháp println, như thể hiện trong hình 5. Trang này cho bạn biết println là gì ("Print a String and then …") và trỏ tới các trang hữu ích khác, như trang có tài liệu cho String.

phương pháp println. ">

Hình 5: Mô tả phương pháp println.
Sử dụng danh sách các lớp học

Dưới đây là cách tìm một mục nhập trong API bằng cách bắt đầu trong danh sách các lớp học:

Truy cập tài liệu. oracle. com / javase / 8 / docs / api /.

Tìm trang tài liệu lớp Hệ thống.
Bạn đang tìm tài liệu giải thích về Hệ thống. ngoài. println. Vì vậy, bạn nhìn lên hệ thống, làm việc theo cách của bạn ra ngoài, và từ đó, làm việc theo cách của bạn để println.

Để tìm liên kết đến Hệ thống, hãy tìm trong khung dưới bên trái của trang. (Xem Hình 6.) Để có các gợi ý về việc tìm kiếm văn bản trên trang, hãy xem Bước 3 trong phần "Sử dụng chỉ mục".

Lớp hệ thống. ">
Hình 6: Tìm một liên kết đến lớp Hệ thống.
Nhấp vào liên kết Hệ thống để trình duyệt của bạn hiển thị trang tài liệu cho lớp Hệ thống, như trong Hình 7.
Tài liệu của lớp hệ thống. ">

hình 7: Tài liệu của lớp Hệ thống.
Trên trang tài liệu cho lớp Hệ thống, tìm ra biến ra.
Nếu bạn sử dụng hộp thoại Find của trình duyệt web của mình, bạn phải bấm nút Find Next nhiều lần. (Tên gọi ra quá phổ biến, nó xuất hiện nhiều lần trong một số ngữ cảnh khác nhau trên trang Tài liệu hệ thống.) Khi bạn tìm thấy những gì bạn đang tìm kiếm, bạn sẽ thấy một bảng như trong Hình 4, ở trên.

Trong hàng ra của bảng, nhấp vào liên kết PrintStream.
Theo tài liệu, biến ra đề cập đến một đối tượng thuộc loại PrintStream.Điều này có nghĩa là println là một phần của lớp PrintStream. Đó là lý do tại sao bạn nhấp vào liên kết PrintStream.

Trên trang tài liệu cho PrintStream, tìm println (String).
Bạn thấy một lời giải thích như thể hiện trong hình 5, ở trên.

Bạn có thể làm điều đó, quá

Sau khi làm theo các bước trong bài viết này, bạn có thể bị cám dỗ để nói, "Lớn đối phó! Tôi có thể tìm thấy println trong tài liệu API, nhưng tôi có thể không thể tìm thấy bất cứ điều gì khác. Và nếu mọi người tạo tài liệu cho các công cụ mà họ tự lập trình, thì tài liệu của họ sẽ không giống như tài liệu API chuẩn. Tôi sẽ lên một con suối. "

Phản ứng thích hợp đối với phản đối như vậy là" Vô nghĩa! Vớ vẩn! Balderdash! Lông ngựa! "Đây là lý do tại sao:

Hầu hết các thủ thuật bạn cần cho việc tìm kiếm những thứ trong tài liệu Java tiêu chuẩn được minh họa trong hướng dẫn từng bước của bài viết này. Nếu bạn có thể tìm thấy Hệ thống. ngoài. println, bạn cũng có thể tìm thấy javax. lung lay. JButton hoặc bất kỳ chương trình nào trong số 4, 200 trong tiêu chuẩn Java API.

Và, khi bạn khám phá nhiều hơn về Java và các mối quan hệ giữa các lớp, phương pháp và biến, hướng dẫn từng bước của bài viết sẽ cảm thấy tự nhiên hơn.

Đối với việc đọc tài liệu của người khác, bạn có thể làm hỏng vấn đề ngay trong danh sách của mình. Tài liệu API chuẩn đã không được gõ bằng tay. Chúng được tạo ra tự động từ mã chương trình Java thực tế. Ví dụ: mã cho PrintStream. java có một vài dòng trông giống như sau:
/ ** * In một String và sau đó kết thúc dòng. * Phương pháp này hoạt động như thể nó sẽ viện dẫn *
```
{@ link #print (String)}

* và sau đó

{@ link #println ()}

. * * @param x Dòng

Chuỗi

được in. * /

Để tạo tài liệu API, các thuyền trưởng của Java chạy một chương trình gọi là
```
javadoc . Chương trình javadoc lấy các dòng giống như vậy ngay trong PrintStream. java tập tin và sử dụng các đường dây để làm cho các tài liệu mà bạn nhìn thấy trong trình duyệt web của bạn. Các lập trình viên Java khác cũng làm điều tương tự. Trên thực tế, tất cả những người viết mã Java đều sử dụng chương trình javadoc để tạo ra tài liệu. Vì vậy tài liệu Java của mọi người giống như tài liệu Java của người khác. Khi bạn biết cách đọc tài liệu API chuẩn, bạn biết cách đọc tài liệu Java của bản thân bất kỳ ai.

Và có, bạn có thể sử dụng chương trình javadoc để tạo tài liệu của riêng bạn. Khi bạn tải về JDK, bạn sẽ có được chương trình javadoc như là một phần của giao dịch.