How to add reference to a method parameter in javadoc?

java arguments javadoc
ripper234 picture ripper234 · Nov 3, 2009 · Viewed 129k times · Source

Is there a way to add references to one or more of a method's parameters from the method documentation body? Something like:

/**
 * When {@paramref a} is null, we rely on b for the discombobulation.
 *
 * @param a this is one of the parameters
 * @param b another param
 */
void foo(String a, int b)
{...}

Answer

Kevin Bourrillion picture Kevin Bourrillion · Nov 4, 2009

As far as I can tell after reading the docs for javadoc there is no such feature.

Don't use <code>foo</code> as recommended in other answers; you can use {@code foo}. This is especially good to know when you refer to a generic type such as {@code Iterator<String>} -- sure looks nicer than <code>Iterator&lt;String&gt;</code>, doesn't it!

Related questions

Mockito match any class argument

Is there a way to match any class argument of the below sample routine? class A { public B method(Class<? extends A> a) {} } How can I always return a new B() regardless of which class is passed into …

Read More
Java variable number or arguments for a method

Is it possible to declare a method that will allow a variable number of parameters ? What is the symbolism used in the definition that indicate that the method should allow a variable number of parameters? Answer: varargs

Read More
Netbeans how to set command line arguments in Java

I am trying to set command line arguments in a Netbeans 7.1 Java project on Windows 7 64 bit. Netbeans is not passing the arguments I give it. I go to Project --> Properties --> Run --> and type the …

Read More