在 java doxygen 注释中指示方法参数答案

【问题标题】：Indicating a method argument in java doxygen comment在 java doxygen 注释中指示方法参数
【发布时间】：2015-03-09 12:46:02
【问题描述】：

我正在调查是否有办法在 java 方法的 doxygen 注释中表明您指的是方法参数。基本上我发现<h> 或@a h 或@p h 表明h 是一个方法参数（参见下面的示例）。指示方法参数有什么区别/推荐的方式吗？

/**
 * Set height to @a h
 */
function setHeight(int h) {
    this.height = h;
}

/**
 * Set height to <h>
 */
function setHeight(int h) {
    this.height = h;
}

/**
 * Set height to @p h
 */
function setHeight(int h) {
    this.height = h;
}

【问题讨论】：

不确定我是否正确理解了您的问题，但@param 怎么样
我希望能够在一般描述或@brief 描述中标记方法参数。我不是指单独的参数描述。

标签： java doxygen

【解决方案1】：

@a 和 @p 都可以很好地解决问题并且是等效的。 <h> 不是 doxygen 支持的。

【讨论】：

两者之一折旧了吗？
不，我添加两者是为了与其他文档工具更兼容。