JavaDoc:在哪里添加注释/备注到文档？

Question

在C#中进行编码时,我总是发现标签remarks对于提供有关类或方法实现的注释非常有用,或者提供有关我正在实现的理论的信息.我现在正在使用Java,但我找不到合适的JavaDoc标记.也许在Java中你以不同的方式实现这一点,有人知道吗？

Answer 1

据我所知,没有任何专用的Javadoc标记用于注释或备注.通常,Javadoc的第一句应该给出类/方法/字段的简要描述.然后应该完整描述.如果你想要包含任何音符,那么带有"Note:"前缀的专用段就足够了.

/**
 * Brief description. Full description of the method, generally without
 * implementation details.
 * <p>
 * Note: Additional information, e.g. your implementation notes or remarks.
 * </p>
 * @param input description of the parameter
 * @return description of return value
 * 
 * @since version
 * @author name of the author
 */
public boolean doSomething(String input)
{
    // your code
}

Answer 2

Java编程语言的迭代8次,终于被设置有三个额外的标记开发商可以把自己的代码的文档中使用-而且应该满足您的需求:@apiNote,@implSpec和@implNote(参考,例如,对于更详细的讨论:博客. codefx.org/java/new-javadoc-tags/).

Answer 3

您也可以创建自己的自定义标签。

这是一个包含自定义标签“@note”的 javadoc 注释：

    /**
     * Quark represents a quark.
     *
     * @note If you spin a quark, it will spin forever!
     */
    public class Quark {

    }

要为上述生成 javadoc，请像这样运行 javadoc：

javadoc -tag note:a:"Note:" Quark.java

来源：http : //www.developer.com/java/other/article.php/3085991/Javadoc-Programming.htm

Answer 4

如果您认为实现细节足够有趣,可以成为Javadoc的一部分,那么您应该只在Javadoc注释本身的段落中提供它们:

/**
 * Does something.
 * <p>
 * <b>Implementation details:</b><br />
 * Blah blah blah...
 * </p>
 */
public void doSomething() {
    // ...
}