Javadoc @param 与 -

Question

我正在制作 javadoc：

/**
 * make Something
 *
 * @param value - blabla( I´m using @param value - blabla, instead @param
 * value blabla)
 * @return something
 */
public String makeSomething(String value) {

    return "";
}

我应该使用 @param value - 还是只使用 @param value？

Answer 1

大多数 doclet 在 @param 标记和参数名称之间引入了一个连字符。自己添加另一个 hypen 会导致呈现丑陋的双 hypen。

Javadoc @param 与 -

Javadoc @param with -

java

javadoc