Search code examples
javaparam

How Exactly Does @param Work - Java


How does the annotation @param work?

If I had something like this:

/* 
*@param testNumber;
*/

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

How would the @param affect the testNumber? Does it even affect the testNumber?

Thanks. Let me know if I used it wrong.


Solution

  • @param won't affect the number. It's just for making javadocs.

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