Jak dokładnie działa program @param - Java

Question

Jak działa adnotacja @param?

Gdybym miał coś takiego:

/* 
*@param testNumber; 
*/ 

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

Jak miałby @param wpływa na testNumber? Czy ma to wpływ nawet na numer testowy?

Dzięki. Daj mi znać, jeśli użyłem tego źle.

Answer 1

@param nie wpłynie na liczbę. Uważam, że to tylko tworzenie javadoków.

Więcej na javadoc: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 2

@param to specjalny komentarz format używany przez javadoc do generowania dokumentacji. służy do oznaczenia opisu parametru (lub parametrów), który może otrzymać metoda. istnieje również @return i @see używany do opisania wartości zwracanych i powiązane informacje odpowiednio:

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

ma, między innymi, w tym:

/** 
* 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 nie wpłynie testNumber.It jest Javadoc komentarz - czyli używany do generowania dokumentacji. Możesz wstawić komentarz Javadoc bezpośrednio przed klasą, polem, metodą, konstruktorem lub interfejsem, takim jak @param, @return. Generalnie zaczyna się od "@" i musi być pierwszą rzeczą na linii.

Zaletą korzystania z jest: - Tworząc proste klasy Java, które zawierają atrybuty i niektóre niestandardowe znaczniki Javadoc, można zezwolić tym klasom, aby służyły jako prosty opis metadanych do generowania kodu.

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

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

Ilekroć w kodzie, jeśli ponowne wykorzystanie metody testNumberIsValid, IDE pokaże parametry metoda akceptuje i rodzaj powrotu metody.

Answer 4

Jest to w zasadzie komentarz. Jak wiemy, wiele osób pracujących nad tym samym projektem musi mieć wiedzę na temat zmian w kodzie. W programie robimy notatki dotyczące parametrów.