Как работает @param Work - Java

Question

Как работает аннотация @param?

Если я что-то вроде этого:

/* 
*@param testNumber; 
*/ 

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

Как бы @param повлиять на testNumber? Может ли это повлиять на testNumber?

Спасибо. Дайте мне знать, если я ошибаюсь.

Answer 1

@param не повлияет на количество. Я считаю, что это просто для создания javadocs.

Подробнее о Javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 2

@param это специальный формат, используемый комментарий Javadoc для создания документации. он используется для обозначения описания параметра (или параметров), который может получить метод. есть также @return и @see используется для описания возвращаемых значений и связанную с ними информацию, соответственно:

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

имеет, помимо всего прочего, это:

/** 
* 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 не повлияет testNumber.It является Javadoc комментарий - т.е. используется для генерации документации. Вы можете поместить комментарий Javadoc непосредственно перед классом, полем, методом, конструктором или интерфейсом, например @param, @return. Обычно начинается с '@' и должно быть первым, что стоит на линии.

Достоинством использования @param является: - . Создавая простые классы Java, которые содержат атрибуты и некоторые пользовательские теги Javadoc, вы позволяете этим классам служить в качестве простого описания метаданных для генерации кода.

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

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

Всякий раз, когда в вашем коде, если вы повторно использовать метод testNumberIsValid, IDE покажет вам параметры метод принимает и тип возвращаемого значения метода.

Answer 4

Это в основном комментарий. Как известно, многие люди, работающие над одним и тем же проектом, должны знать о изменениях кода. Мы делаем некоторые заметки в программе о параметрах.