考虑一个类中的静态方法,我已经使用javadoc记录了它:
/**
* Description here.
*
* @param names - The parameters of the impression request.
* @param ids - An intent object to enrich.
* @param prefix - A prefix.
*/
public static void parse(Map<String, String> names, String ids, String prefix)
...
Run Code Online (Sandbox Code Playgroud)
为了避免重复方法的重载版本中的描述,我想使用javadoc @link:
/**
* Overloaded version with default prefix.
* {@link #<parse(Map<String, String>, String, String)> [Text]}
*/
public static void parse(Map<String, String> names, String ids, String prefix)
Run Code Online (Sandbox Code Playgroud)
这给出了以下警告:
@link:illegal character: "60" in "#parseBtCategories(Map<String, String>, …Run Code Online (Sandbox Code Playgroud)