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

как в аннотации @param работы?

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

/* 
*@param testNumber;
*/

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

как бы @param влияет на testNumber? Это даже влияет на номер теста?

спасибо. Дайте мне знать, если я использовал его неправильно.

19
java param

4 ответов

@param не повлияет на номер. Я считаю, что это только на оформление документации.

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

13

@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) {
22

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

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

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

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

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

3

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

0