Javadoc-引用文档中另一点的参数，如@link

我有一个名为ErrorHandler的类，负责处理所有错误消息。目前我正在为这个类编写JavaDoc，但我遇到了一个问题。在我的课堂上，我有几个不同的脉冲常数，可以描述所有不同的错误类型

举几个例子：

/**
*这里我想引用参数errorType
*/
公共静态void final String INVALID_COMMAND=“INVALID_COMMAND”；
公共静态无效最终字符串无效\u NUMBER=“无效\u NUMBER”；

这些常量在my

printErrorMessage

方法中用作确定发生了哪个错误的参数

我的方法如下所示：

/**
*根据附加的错误类型打印错误消息。
*
*@param errorType发生的错误类型
*@see#无效的_命令
*@see#无效#编号
*/
公共静态无效打印错误消息（字符串错误类型）{
//做事情
}

我现在的问题是：当我编写常量文档时，如何引用参数

errorType

，告诉其他开发者我的常量被用作

errorType

如果我的意图没有达到我的预期。有人能告诉我怎么做吗。

您可以用它为您的方法指定可能的常量值

例如：

/**
* Prints an error message according to the type of error that is appended.
*
* @param errorType type of error that occurred
* Possible values:
* {@value #INVALID_COMMAND},
* {@value #INVALID_NUMBER}
*/
public static void printErrorMessage(String errorType) {
    //does stuff
}

或者，如果可能的错误类型数量有限，则可以创建一个枚举类，并将所述字符串常量作为值。通过这种方式，您可以显式指定允许的值，并且没有人可以将一些随机字符串作为参数传递

更新：

正如@Andreas所提到的，在上面的代码中，链接是在method->constant之间。 如果需要相反的关系，则可以使用以下代码：

/**
* Is used as a parameter for the {@link #printErrorMessage(String) errorType}
*/
public static final String INVALID_COMMAND = "invalid_command";
public static final String INVALID_NUMBER = "invalid_number";

您无法链接到参数，因此需要记录参数名称并链接到方法

/**
*用于中的{@code errorType}参数
*调用{@link#printErrorMessage（String）}。
*/
公共静态最终字符串无效\u命令=“无效\u命令”；

结果javadoc如下所示：

用于调用中的

errorType

参数

---

AS，您应该考虑使用<代码> EnUM <代码>代替字符串常量。

/**
*@请参阅{@link MyClass#printErrorMessage（String）printErrorMessage（String typeName）}
*/
公共枚举错误类型{
无效的命令（“无效的命令”），
无效的_编号（“无效_编号”）；
私有最终字符串类型名；
私有错误类型（字符串类型名）{
this.typeName=typeName；
}
公共字符串getTypeName（）{
返回此.typeName；
}
}

/**
*根据附加的错误类型打印错误消息。
*
*@param errorType发生的错误类型
*@see ErrorType#无效的_命令
*@请参阅ErrorType#无效的_编号
*/
公共静态无效printErrorMessage（ErrorType ErrorType）{
//做事情
}

应该是

@param errorType

@Tushortz

@param

将用于记录我的方法的

errorType

。但是，我想记录我的常量。您可以为错误类型创建一个

enum

，而不是依赖文档。OP要求以另一种方式链接，即让字段链接到方法的参数。