Hoe werkt @param precies – Java

Hoe werkt de annotatie @param?

Als ik zoiets als dit had:

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

Hoe zou de @param het testNummer beïnvloeden? Heeft het zelfs invloed op het testnummer?

Bedankt. Laat het me weten als ik het verkeerd heb gebruikt.


Antwoord 1, autoriteit 100%

@param heeft geen invloed op het nummer. Het is alleen bedoeld om javadocs te maken.

Meer over javadoc:
http://www.oracle.com/technetwork/java/javase /documentation/index-137868.html


Antwoord 2, autoriteit 94%

@param is een speciaal formaat commentaar dat door javadoc wordt gebruikt om documentatie te genereren. het wordt gebruikt om een ​​beschrijving aan te geven van de parameter (of parameters) die een methode kan ontvangen. er worden ook @return en @see gebruikt om respectievelijk retourwaarden en gerelateerde informatie te beschrijven:

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

heeft onder andere dit:

/**
 * 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) {

Antwoord 3, autoriteit 21%

@param heeft geen invloed op testNumber. Het is een Javadoc-opmerking – d.w.z. gebruikt voor het genereren van documentatie.
U kunt een Javadoc-opmerking direct voor een klasse, veld, methode, constructor of interface zoals @param, @return plaatsen.
Begint over het algemeen met ‘@‘ en moet als eerste aan de lijn zijn.

Het voordeel van het gebruik van @param is:-
Door eenvoudige Java-klassen te maken die attributen en enkele aangepaste Javadoc-tags bevatten, staat u toe dat deze klassen dienen als een eenvoudige metadatabeschrijving voor het genereren van code.

    /* 
       *@param testNumber
       *@return integer
    */
    public int main testNumberIsValid(int testNumber){
       if (testNumber < 6) {
          //Something
        }
     }

Wanneer u in uw code de testNumberIsValid-methode opnieuw gebruikt, zal IDE u de parameters tonen die de methode accepteert en het type van de methode retourneren.


Antwoord 4

Het is eigenlijk een opmerking. Zoals we weten, moeten een aantal mensen die aan hetzelfde project werken, kennis hebben van de codewijzigingen. We maken enkele aantekeningen in het programma over de parameters.


Antwoord 5

Misschien mis je @author en binnen @param moet je uitleggen waar die parameter voor is, hoe je hem moet gebruiken, enz.

LEAVE A REPLY

Please enter your comment!
Please enter your name here

one + seventeen =

Other episodes