Javadoc @param with -

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？

- Goldbones

---

我认为通常情况下你会省略连字符。在生成实际的Javadoc时，参数名称后面的所有内容都是描述信息，因此使用连字符会将连字符添加到您的描述信息开头。 - Mage Xy

使用带有值描述的@param值是一个很好的文档选项。 - Vivek Singh

Answer 1

大多数doclets在@param标签和参数名称之间加入连字符。自行添加另一个连字符会导致出现丑陋的双重连字符。

- Mureinik