文档注释的问题

Question

/** Checks to make sure that the @param ch is not a white space, if so returns true, if not returns false*/
public static boolean isWhiteSpace(char ch)
{
    if(ch == ' ')
        return true; 
    else
        return false;
}

我正在写文档评论，当我使用 @param 功能时，它会跟随到我的文档评论中。这应该发生吗？

Answer 1

我不太确定你在问什么。

要进行 JavaDoc 注释，您首先要执行以下操作：

/**
 *  Checks to see if a character contains a whitespace character or not.
 *
 *  @param ch Character to check for whitespace
 */

编辑：您通常不会在描述中引用变量，而是在其下方。

Answer 2

是的，这应该发生。 @param 不是 block tag，因此不能放在那个部分。

只有可以放置@param的地方是标签部分。

为此，避免像这样编写 Javadoc。无论如何，您想描述行为而不是依赖于此上下文中的变量。

像这样会更好：

/** Checks to see if the provided argument is a space.
 * @param ch the character passed through
 * @return true if the character is a space, false otherwise.
 */
public boolean isWhiteSpaceChar(char ch) {
    // impl
}

Take a gander at the official style guide 了解更多相关信息。

文档注释的问题

Trouble with doc comments

java

javadoc