Cách hoạt động chính xác của @param Work - Java

Question

Chú thích @param hoạt động như thế nào?

Nếu tôi có một cái gì đó như thế này:

/* 
*@param testNumber; 
*/ 

int testNumber = 5; 
if (testNumber < 6) { 
    //Something 
} 

Làm thế nào sẽ là @param ảnh hưởng đến testNumber? Nó thậm chí có ảnh hưởng đến testNumber không?

Cảm ơn. Hãy cho tôi biết nếu tôi đã sử dụng sai.

Answer 1

@param sẽ không ảnh hưởng đến số. Tôi tin rằng nó chỉ là để làm javadocs.

Thông tin thêm về javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 2

@param là một định dạng bình luận đặc biệt được sử dụng bởi javadoc để tạo ra tài liệu. nó được sử dụng để biểu thị một mô tả của tham số (hoặc các tham số) mà một phương thức có thể nhận được. có cũng @return và @see dùng để mô tả giá trị trả về và các thông tin có liên quan, tương ứng:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

có, trong số những thứ khác, điều này:

/** 
* Returns an Image object that can then be painted on the screen. 
* The url argument must specify an absolute {@link URL}. The name 
* argument is a specifier that is relative to the url argument. 
* <p> 
* This method always returns immediately, whether or not the 
* image exists. When this applet attempts to draw the image on 
* the screen, the data will be loaded. The graphics primitives 
* that draw the image will incrementally paint on the screen. 
* 
* @param url an absolute URL giving the base location of the image 
* @param name the location of the image, relative to the url argument 
* @return  the image at the specified URL 
* @see   Image 
*/ 
public Image getImage(URL url, String name) { 

Answer 3

@param sẽ không ảnh hưởng testNumber.It là một Javadoc nhận xét - tức là được sử dụng để tạo tài liệu. Bạn có thể đặt một nhận xét Javadoc ngay trước một lớp, trường, phương thức, hàm tạo hoặc giao diện chẳng hạn như @param, @return. Thường bắt đầu bằng '@' và phải là điều đầu tiên trên dòng.

Lợi thế của việc sử dụng @param là: - Bằng cách tạo các lớp Java đơn giản có chứa thuộc tính và một số thẻ Javadoc tùy chỉnh, bạn cho phép các lớp đó phân phát dưới dạng mô tả siêu dữ liệu đơn giản để tạo mã.

/* 
     *@param testNumber 
     *@return integer 
    */ 
    public int main testNumberIsValid(int testNumber){ 

     if (testNumber < 6) { 
      //Something 
     } 
    } 

Bất cứ khi nào trong mã của bạn nếu bạn sử dụng lại phương pháp testNumberIsValid, IDE sẽ hiển thị cho bạn các tham số mà phương thức chấp nhận và trả về kiểu phương pháp.

Answer 4

Về cơ bản, đó là nhận xét. Như chúng ta biết, một số người làm việc trên cùng một dự án phải có kiến ​​thức về những thay đổi mã. Chúng tôi đang thực hiện một số lưu ý trong chương trình về các tham số.