Cách tạo thẻ javadoc tùy chỉnh?

Question

Làm cách nào để tạo thẻ javadoc tùy chỉnh như @pre/@post? Tôi tìm thấy một số liên kết giải thích nó nhưng tôi đã không có may mắn với họ. Đây là một số trong các liên kết:

http://www.developer.com/java/other/article.php/3085991/Javadoc-Programming.html

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html

Answer 1

mã java

/** 
* @custom.mytag hey ho... 
*/ 

java tùy chọn doc

-tag custom.mytag:a:"This is my Tag:" 

đầu ra

Đây là Tag của tôi:

hey ho ...

Answer 2

Vâng những gì tôi đã làm không phải là giải pháp tốt nhất nhưng có thể đọc:

/** <p><b>Pre:</b></p> <Ul>True</Ul> 
    * <p><b>Post:</b></p> <Ul>The x is pushed onto the top of the stack, 
    *      and the rest of the stack remains unchanged.</Ul> 
    * 
    * @param x    Indicates the current node 
    */ 
    public void push(int x){ 
     ... 
    } 

Till một câu trả lời thích hợp được tìm thấy, hy vọng nó giúp!

Answer 3

thẻ tùy chỉnh không nên được tạo ra sử dụng HTML vì javadoc có thể thay đổi đó là thực hiện hoặc làm thế nào nó trình bày dữ liệu, có thể họ sẽ bắt đầu sử dụng Markdown trong tương lai , cũng là nhà xuất khẩu Javadoc sẽ không nắm bắt thông tin còn thiếu và bạn có thể có "thẻ" trống.

sử dụng đầu tiên bất cứ điều gì từ khóa bạn muốn:

/** 
* Comments and a {@link #methodLink} for this method. 
* 
* @tt.wrapper {@link OtherClass} 
* 
*/ 
public String extractName() { 
    // method contents 
} 

ý rằng thẻ tùy chỉnh có định dạng @[prefix].[tagName], điều này là do thực tế là Doclet (hoặc một plugin Eclipse) có thể phát hành nó thẻ riêng với cùng và thẻ của bạn sẽ chỉ ghi đè thẻ tiêu chuẩn, vì vậy, chúng tôi thêm tiền tố để làm cho nó ít có khả năng xảy ra hơn.

Nhận xét từ doclet.

Thẻ tùy chỉnh có thể ghi đè thẻ tiêu chuẩn trong tương lai: @wrapper Để tránh ghi đè tiềm năng, hãy sử dụng ít nhất một ký tự dấu chấm (.) Trong tên thẻ tùy chỉnh.

---

Bây giờ bạn phải nói với nhà xuất khẩu Javadoc về thẻ tùy chỉnh này, @tt.wrapper. Chuyển đến Project > Generate Javadoc.. trong Eclipse (Indigo trong trường hợp của tôi).

Sau khi cấu hình các thiết lập cho hai màn hình đầu tiên của hộp thoại này (sử dụng "Next" để thay đổi màn hình), bạn sẽ thấy màn hình này:

Bạn nên lưu ý rằng "tùy chọn Javadoc Extra. ."hộp văn bản có giá trị bạn phải thêm cho nhà xuất khẩu Javadoc để tạo tương đương HTML cho thẻ của bạn.

Trong trường hợp của chúng tôi, tùy chọn này là (nếu bạn muốn nhiều thẻ, đặt chúng trên một dòng mới):

-tag tt.wrapper:a:"API Wrapper:" 

Bây giờ khi bạn xuất Javadoc của bạn (tôi cũng khuyên bạn nên tiết kiệm một kịch bản ANT vì vậy bạn không cần phải đi qua hộp thoại này mỗi lần), bạn sẽ có thẻ tùy chỉnh của bạn in đậm với mô tả, và các giá trị bên dưới

PS Tôi chưa tìm cách thêm khả năng thêm tự động hoàn thành cho c các thẻ ustom, nhưng có vẻ như không thể ở Indigo, có thể nó sẽ có trong các bản phát hành trong tương lai (không chắc chắn nếu Juno có nó).

Answer 4

Nếu bạn muốn nhiều, hãy làm điều gì đó như javadoc -tag pre -tag post -tag invariant nơi yêu cầu đối số dòng lệnh. Không sử dụng công cụ html