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

时间:2015-01-11 18:06:01

标签: java doxygen

我正在研究是否有一种方法可以在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;
}

1 个答案:

答案 0 :(得分:1)

@a@p都可以很好地完成这个操作并且是等效的。 <h>不是doxygen支持的东西。