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

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

Если бы у меня было что-то вроде этого:

/* 
*@param testNumber;
*/

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

Как повлияет @param на testNumber? Это даже влияет на testNumber?

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

ОТВЕТЫ

Ответ 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) {

Ответ 3

@param не повлияет на testNumber. Это комментарий Javadoc - используется для создания документации. Вы можете поместить комментарий Javadoc непосредственно перед классом, полем, методом, конструктором или интерфейсом, например @param, @return. Обычно начинается с " @" и должно быть первым в строке.

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

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

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

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

Ответ 4

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