sự khác biệt giữa/* ... */và là gì/** ... */

Question

tôi đã nhận thấy rằng Eclipse in các định dạng khác nhau để nhận xét:

/* Eclipse prints it in green 
*/ 

hoặc nếu bạn viết:

/** Eclipse prints it in blue 
*/ 

Sự khác nhau giữa 2 loại nhận xét này là gì?

Answer 1

/* 
* It is multi-line comment in Java 
* 
*/ 

/** 
* It is a Javadoc. Can be found above methods and Class definitions. 
* 
* 
*/ 

Dưới đây là một đoạn trích từ Wikipedia về Javadoc:

Một bình luận Javadoc được đặt ra từ mã theo tiêu chuẩn bình luận nhiều dòng Thẻ/* và * /. Thẻ mở (được gọi là dấu phân cách bắt đầu-nhận xét), có dấu hoa thị phụ, như trong/**.

The first paragraph is a description of the method documented. 
Following the description are a varying number of descriptive tags, signifying: 
    The parameters of the method (@param) 
    What the method returns (@return) 
    Any exceptions the method may throw (@throws) 
    Other less-common tags such as @see (a "see also" tag) 

Lớp mức Javadoc Ví dụ:

/** 
* @author  Firstname Lastname <address @ example.com> 
* @version  1.6     (current version number of program) 
* @since  2010-03-31   (the version of the package this class was first added to) 
*/ 
public class Test { 
    // class body 
} 

Phương pháp mức Javadoc Ví dụ:

/** 
* Short one line description.       
* <p> 
* Longer description. If there were any, it would be  
* here. 
* <p> 
* And even more explanations to follow in consecutive 
* paragraphs separated by HTML paragraph breaks. 
* 
* @param variable Description text text text.   
* @return Description text text text. 
*/ 
public int methodName (...) { 
    // method body with a return statement 
} 

Answer 2

/* ... */ 

chỉ đơn giản là một nhận xét.

/** ... */ 

là một javadoc, mà sau đó có thể được chuyển đổi thành một tài liệu HTML thoải mái bởi một công cụ gọi là, kỳ quặc đủ, javadoc. Công cụ này xem xét chính chú thích javadoc, khai báo lớp/giao diện/phương thức và mọi triển khai/hợp đồng siêu/phân lớp khác (trong việc tạo thông tin "được chỉ định bởi" và "ghi đè" trên các phương thức, ví dụ). Ví dụ đáng chú ý nhất về điều này là Java SE API doc itself.

Nhận xét tài liệu này bao gồm đánh dấu riêng, ví dụ: @see Bar. Nó có thể chỉ định các cân nhắc chương trình như các tham số phương thức và các mô tả của chúng, kiểu trả về của phương thức, các ngoại lệ mà phương thức được khai báo để ném và các tình huống mà chúng sẽ được ném và các thông tin khác.

Ví dụ, ArrayList#toArray() được ghi chép lại như

public <T> T[] toArray(T[] a)

Trả về một mảng chứa tất cả các yếu tố trong danh sách này trong chuỗi thích hợp (từ đầu đến yếu tố cuối cùng); kiểu thời gian chạy của mảng trả về là của mảng được chỉ định. Nếu danh sách phù hợp trong mảng được chỉ định , nó sẽ được trả về trong đó. Nếu không, một mảng mới là được phân bổ với loại thời gian chạy của mảng được chỉ định và kích thước của danh sách này.

Nếu danh sách phù hợp trong mảng được chỉ định có chỗ trống (tức là, mảng có nhiều phần tử hơn danh sách), phần tử trong mảng ngay sau khi kết thúc bộ sưu tập được đặt thành rỗng.( này rất hữu ích trong việc xác định độ dài của danh sách chỉ khi người gọi biết rằng danh sách này không chứa bất kỳ yếu tố null.)

rõ bởi:
toArray trong giao diện Collection
rõ bởi:
toArray trong Danh sách giao diện
Overrides:
toArray trong lớp AbstractCollection
Loại Các tham số:
T - loại thời gian chạy của mảng để chứa bộ sưu tập
Tham số:
a - mảng vào đó các phần tử của danh sách đang được lưu trữ, nếu nó là đủ lớn; nếu không, một mảng mới của cùng một kiểu thời gian chạy được phân bổ cho mục đích này.
Returns:
một mảng chứa các phần tử của danh sách
Ném:
ArrayStoreException - nếu loại thời gian chạy của các mảng được chỉ định không phải là một siêu kiểu của các loại thời gian chạy của mọi phần tử trong danh sách này
NullPointerException - nếu mảng được chỉ định là null

từ

/** 
* Returns an array containing all of the elements in this list in proper 
* sequence (from first to last element); the runtime type of the returned 
* array is that of the specified array. If the list fits in the 
* specified array, it is returned therein. Otherwise, a new array is 
* allocated with the runtime type of the specified array and the size of 
* this list. 
* 
* <p>If the list fits in the specified array with room to spare 
* (i.e., the array has more elements than the list), the element in 
* the array immediately following the end of the collection is set to 
* <tt>null</tt>. (This is useful in determining the length of the 
* list <i>only</i> if the caller knows that the list does not contain 
* any null elements.) 
* 
* @param a the array into which the elements of the list are to 
*   be stored, if it is big enough; otherwise, a new array of the 
*   same runtime type is allocated for this purpose. 
* @return an array containing the elements of the list 
* @throws ArrayStoreException if the runtime type of the specified array 
*   is not a supertype of the runtime type of every element in 
*   this list 
* @throws NullPointerException if the specified array is null 
*/ 

Answer 3

Họ là 3 loại ý kiến ​​trong java:

Độc ligne bình luận

// This is a single line comment 

Multi-dòng chú thích

/* This is a 
multi-line comment */ 

Documentation comment

/** 
* This is a <b>documentation comment</b> 
*/ 

Trình biên dịch sẽ bỏ qua tất cả nhưng công cụ javadoc sẽ sử dụng chú thích doc cho thế hệ javadoc, bạn có thể sử dụng định dạng HTML. Bạn cũng có thể sử dụng thẻ như @see hoặc @author