在 java doxygen 注释中指示方法参数
Indicating a method argument in java doxygen comment
我正在研究是否有一种方法可以在 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;
}
@a
和 @p
都可以很好地解决问题并且是等效的。 <h>
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;
}
@a
和 @p
都可以很好地解决问题并且是等效的。 <h>
doxygen 不支持。