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

是的，这应该发生。 @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了解更多内容。

Answer 2

我不完全确定你在问什么。

要制作JavaDoc评论，首先要执行以下操作：

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

编辑：您通常不会在说明中引用变量，但在其下方。

麻烦与doc评论

2 个答案: