Javadoc cho các biến cục bộ?

Question

Câu hỏi ngắn: Có thể tạo Javadoc cho các biến cục bộ không? (Tôi chỉ muốn một lời giải thích cho biến địa phương của tôi khi lơ lửng trên nó trong Eclipse) Cảm ơn bất kỳ gợi ý :-)

Answer 1

Biến cục bộ phải được khai báo một vài dòng trên mức sử dụng của nó. Chỉ cần sử dụng bình luận bình thường nếu bạn cần. Nhưng quan trọng hơn, hãy giữ các phương thức ngắn gọn, chọn các tên có ý nghĩa cho chúng và chỉ khai báo chúng khi bạn cần chúng. Hầu hết thời gian, hoàn toàn không cần thiết để nhận xét các biến cục bộ.

thích

int numberOfBooks = books.size(); 

qua

// the number of books 
int n; 
... // 50 lines of code 
n = books.size(); 

Answer 2

Không, nó không được hỗ trợ vì thế hệ javadoc sẽ bỏ qua nó.

Answer 3

Có thể. Chỉ cần thực hiện bình luận javadoc thông thường ở trên biến.

public class ExampleClass { 
    /** A really cool variable */ 
    int localVariable; 

    ... 

Bây giờ bạn có thể di chuột lên trên biến trong mã tiếp tục xuống và nhận xét sẽ được hiển thị.

Answer 4

Có thể thực hiện bằng cách sử dụng Annotations.

Tạo một kiểu chú thích đơn giản như sau:

@Retention(RetentionPolicy.SOURCE) 
@Target(ElementType.LOCAL_VARIABLE) 
@interface LocalVariableDocumentation { 
    String value(); 
} 

Và sử dụng nó trên biến địa phương của bạn:

@LocalVariableDocumentation("A very important object!") 
Object anImportantObject; 

Eclipse sẽ hiển thị các chú thích trong tooltip.

Answer 5

Cách duy nhất có thể là với các biến toàn cục. Các biến cục bộ không thể được chú thích bằng JavaDoc.

Answer 6

Chỉ cần tạo một liên kết để biến địa phương của bạn

String someLocalVariable; 
/** 
* This a local variable: {@link #someLocalVariable} 
*/