How to add reference to a method parameter in javadoc

Question

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

User · Answer

The correct way of referring to a method parameter is like this

User · Answer

I guess you could write your own doclet or taglet to support this behaviour   Taglet Overview  Doclet Overview

User · Answer

As you can see in the Java Source of the java lang String class          Allocates a new  lt code gt String lt  code gt  that contains characters from    a subarray of the character array argument  The  lt code gt offset lt  code gt     argument is the index of the first character of the subarray and    the  lt code gt count lt  code gt  argument specifies the length of the    subarray  The contents of the subarray are copied  subsequent    modification of the character array does not affect the newly    created string         param      value    array that is the source of characters      param      offset   the initial offset      param      count    the length      exception  IndexOutOfBoundsException  if the  lt code gt offset lt  code gt                   and  lt code gt count lt  code gt  arguments index characters outside                  the bounds of the  lt code gt value lt  code gt  array      public String char value    int offset  int count        if  offset  lt  0            throw new StringIndexOutOfBoundsException offset             if  count  lt  0            throw new StringIndexOutOfBoundsException count                Note  offset or count might be near -1 gt  gt  gt 1      if  offset  gt  value length - count            throw new StringIndexOutOfBoundsException offset   count              this value   new char count       this count   count      System arraycopy value  offset  this value  0  count       Parameter references are surrounded by  lt code gt  lt  code gt  tags  which means that the Javadoc syntax does not provide any way to do such a thing   I think String class is a good example of javadoc usage

User · Answer

As far as I can tell after reading the docs for javadoc there is no such feature   Don t use  lt code gt foo lt  code gt  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 lt String gt   -- sure looks nicer than  lt code gt Iterator amp lt String amp gt  lt  code gt   doesn t it

[java] How to add reference to a method parameter in javadoc?

Examples related to java

Examples related to arguments

Examples related to javadoc