Thứ Năm, 20 tháng 9, 2018

Java - Nhận xét tài liệu

Học lập trình Java

Ngôn ngữ Java hỗ trợ ba loại bình luận



Sr.No.Nhận xét & mô tả
1/* bản văn */

Trình biên dịch bỏ qua mọi thứ từ / * đến * /.
2//bản văn
Trình biên dịch bỏ qua mọi thứ từ // đến cuối dòng.
3/** tài liệu */
Đây là một bình luận tài liệu và nói chung được gọi là bình luận doc của nó . Công cụ javadoc JDK sử dụng các chú thích doc khi chuẩn bị tài liệu được tạo tự động.
Học lập trình Java : Chương này là tất cả về giải thích Javadoc. Chúng ta sẽ thấy cách chúng ta có thể sử dụng Javadoc để tạo ra các tài liệu hữu ích cho mã Java.

Javadoc là gì?

Javadoc là một công cụ đi kèm với JDK và nó được sử dụng để tạo tài liệu mã Java ở định dạng HTML từ mã nguồn Java, yêu cầu tài liệu theo định dạng được xác định trước.

Sau đây là một ví dụ đơn giản trong đó các dòng bên trong /*….*/ là các nhận xét nhiều dòng Java. Tương tự, dòng có tiền tố // là nhận xét đơn dòng Java.

Thí dụ
/**
* The HelloWorld program implements an application that
* simply displays "Hello World!" to the standard output.
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31 
*/
public class HelloWorld {

   public static void main(String[] args) {
      /* Prints Hello, World! on standard output.
      System.out.println("Hello World!");
   }
}

Bạn có thể bao gồm các thẻ HTML bắt buộc bên trong phần mô tả. Ví dụ: ví dụ sau sử dụng <h1> .... </ h1> cho tiêu đề và <p> đã được sử dụng để tạo ngắt đoạn -

Thí dụ

/**
* <h1>Hello, World!</h1>
* The HelloWorld program implements an application that
* simply displays "Hello World!" to the standard output.
* <p>
* Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
* 
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31 
*/
public class HelloWorld {

   public static void main(String[] args) {
      /* Prints Hello, World! on standard output.
      System.out.println("Hello World!");
   }
}

Thẻ javadoc

Công cụ javadoc nhận ra các thẻ sau

NhãnSự miêu tảCú pháp
@authorThêm tác giả của một lớp.@author name-text
{@code}Hiển thị văn bản trong phông chữ mã mà không diễn giải văn bản dưới dạng đánh dấu HTML hoặc thẻ javadoc lồng nhau.{@code text}
{@docRoot}Đại diện cho đường dẫn tương đối đến thư mục gốc của tài liệu được tạo ra từ bất kỳ trang được tạo nào.{@docRoot}
@được chấp nhậnThêm nhận xét cho biết rằng API này sẽ không còn được sử dụng nữa.@deprecated deprecatedtext
@ngoại lệThêm tiêu đề phụ Ném vào tài liệu được tạo, với tên lớp và văn bản mô tả.@exception class-name description
{@inheritDoc}Thừa kế nhận xét từ lớp kế thừa hoặc giao diện có thể thực hiện gần nhất .Thừa kế một nhận xét từ lớp con ngay lập tức.
{@link}Chèn một liên kết nội tuyến với nhãn văn bản hiển thị trỏ đến tài liệu cho gói, lớp hoặc tên thành viên được chỉ định của lớp được tham chiếu.{@link package.class # nhãn thành viên}
{@linkplain}Giống hệt với {@link}, ngoại trừ nhãn của liên kết được hiển thị ở dạng văn bản thuần túy hơn so với phông chữ mã.{@linkplain package.class # nhãn thành viên}
@paramThêm tham số có tên tham số được chỉ định, theo sau là mô tả được chỉ định cho phần "Tham số".mô tả tên thông số @param
@trở vềThêm phần "Trả về" cùng với văn bản mô tả.@return description
@xemThêm tiêu đề "Xem thêm" với liên kết hoặc mục nhập văn bản trỏ đến tham chiếu.tham khảo @see
@serialĐược sử dụng trong chú thích doc cho trường tuần tự mặc định.@serial field-description |bao gồm | loại trừ
@serialDataTài liệu dữ liệu được viết bởi các phương thức writeObject () hoặc writeExternal ().@serialData mô tả dữ liệu
@serialFieldTài liệu thành phần ObjectStreamField.@serialField field-name field-type field-description
@sinceThêm tiêu đề "Từ" với văn bản từ được chỉ định vào tài liệu được tạo.@since release
@throwsCác thẻ @throws và @exception là các từ đồng nghĩa.@throws class-name description
{@giá trị}Khi {@value} được sử dụng trong nhận xét doc của một trường tĩnh, nó sẽ hiển thị giá trị của hằng số đó.{@value package.class # field}
@phiên bảnThêm tiêu đề phụ "Phiên bản" với văn bản phiên bản được chỉ định vào tài liệu được tạo khi tùy chọn -version được sử dụng.@version phiên bản-văn bản

Thí dụ

Chương trình sau sử dụng một vài trong số các thẻ quan trọng có sẵn để nhận xét về tài liệu. Bạn có thể sử dụng các thẻ khác dựa trên yêu cầu của bạn.

Tài liệu về lớp AddNum sẽ được tạo trong tệp HTML AddNum.html nhưng đồng thời một tệp chính có tên index.html cũng sẽ được tạo.
import java.io.*;

/**
* <h1>Add Two Numbers!</h1>
* The AddNum program implements an application that
* simply adds two given integer numbers and Prints
* the output on the screen.
* <p>
* <b>Note:</b> Giving proper comments in your program makes it more
* user friendly and it is assumed as a high quality code.
*
* @author  Zara Ali
* @version 1.0
* @since   2014-03-31
*/
public class AddNum {
   /**
   * This method is used to add two integers. This is
   * a the simplest form of a class method, just to
   * show the usage of various javadoc Tags.
   * @param numA This is the first paramter to addNum method
   * @param numB  This is the second parameter to addNum method
   * @return int This returns sum of numA and numB.
   */
   public int addNum(int numA, int numB) {
      return numA + numB;
   }

   /**
   * This is the main method which makes use of addNum method.
   * @param args Unused.
   * @return Nothing.
   * @exception IOException On input error.
   * @see IOException
   */

   public static void main(String args[]) throws IOException {
      AddNum obj = new AddNum();
      int sum = obj.addNum(10, 20);

      System.out.println("Sum of 10 and 20 is :" + sum);
   }
}
Bây giờ, xử lý tệp AddNum.java ở trên bằng cách sử dụng tiện ích javadoc như sau:

$ javadoc AddNum.java
Loading source file AddNum.java...
Constructing Javadoc information...
Standard Doclet version 1.7.0_51
Building tree for all the packages and classes...
Generating /AddNum.html...
AddNum.java:36: warning - @return tag cannot be used in method with void return type.
Generating /package-frame.html...
Generating /package-summary.html...
Generating /package-tree.html...
Generating /constant-values.html...
Building index for all the packages and classes...
Generating /overview-tree.html...
Generating /index-all.html...
Generating /deprecated-list.html...
Building index for all classes...
Generating /allclasses-frame.html...
Generating /allclasses-noframe.html...
Generating /index.html...
Generating /help-doc.html...
1 warning
$

Bạn có thể kiểm tra tất cả các tài liệu được tạo ở đây - AddNum . 

Nếu bạn đang sử dụng JDK 1.7 thì javadoc không tạo ra một stylesheet.css tuyệt vời , vì vậy chúng tôi khuyên bạn nên tải xuống và sử dụng biểu định kiểu chuẩn từ
-
Nhãn:

Không có nhận xét nào:

Đăng nhận xét

Đăng ký: Đăng Nhận xét (Atom)

Lập trình Java - Ngoại lệ

Một ngoại lệ (hoặc sự kiện đặc biệt) là một vấn đề phát sinh trong quá trình thực hiện chương trình. Khi xảy ra Ngoại lệ , luồng bình thường...

  • Java - Tuần tự hóa
    Tổng quan : Học lập trình Java cung cấp một cơ chế, được gọi là serialization đối tượng, nơi một đối tượng có thể được biểu diễn như một ...
  • HỌC JAVA WED 4.0
    Khóa Đào Tạo Java 4.0 ĐÀO TẠO JAVA WED 4.0 1 Tổng Quan :  khóa học lập trình java   được  NIIT-ICT HÀ NỘI  phối hợp với doanh nghiệp ...
  • Java - Cú pháp cơ bản
    Học lập trình Java Khi chúng ta xem xét một chương trình Java , nó có thể được định nghĩa như một tập hợp các đối tượng giao tiếp thông qua...