2012-08-01 17 views
11

Tôi muốn khi tôi di chuột qua một phương pháp, tôi có thể xem tài liệu của mình về phương pháp của tôi khi tôi đặt chuột lên phương thức của Java Tôi biết rằng/** */là cách thực hiện nhưng:Làm cách nào để ghi lại phương pháp của tôi trong Java như tài liệu Java?

  1. Bạn giải thích Params là gì?

  2. Làm cách nào để tạo một dòng mới hoặc tạo từ đậm hoặc in nghiêng?

+4

Hãy đọc [tài liệu] (http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html) – pb2q

Trả lời

19

Nếu bạn đang sử dụng Eclipse như IDE, bạn chỉ cần tạo một bình luận với

/** 

và nhấn enter và nó sẽ tạo mã cho Javadoc của bạn, bao gồm thông số, giá trị trả về, v.v. Bạn chỉ cần đưa vào mô tả.

cũng áp dụng cho các tờ khai lớp (nhận xét Javadoc luôn liên quan đến các yếu tố sau)

Lưu ý:

Chú doc phương pháp của bạn, bạn cần phải xác định tên phương pháp trong ý kiến ​​ở đầu .

Ví dụ

/** 
* create_instance 
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
* respectively. 
* @return Instance object 
*/ 
+0

NICE! !!!!!!!!!!!! –

+0

Trong Chứng thư, thường được sử dụng Tính năng –

+0

Bạn có thể làm điều tương tự cho intelliJ – Simon

22

Bạn giải thích Params là gì?

Sử dụng @param tag:

/** 
* @param paramName Explanation of the param 
*/ 
public void foo(String paramName); 

Làm thế nào để bạn tạo ra một dòng sản phẩm mới, hoặc thực hiện một chữ in đậm hoặc in nghiêng?

Sử dụng chuẩn HTML, tức là <p></p>, <br/>, <strong><em> (hoặc ít hơn ngữ nghĩa <b><i>)