JavaDoc：在何处向文档添加注释/备注？

当用C#编写代码时，我总是发现标签

备注

对于提供关于类或方法实现的注释，或者提供关于我实现的理论的信息非常有用。我现在正在使用Java，但是我找不到一个合适的JavaDoc标记。在Java中，您可能以不同的方式完成此任务，有人知道吗？

如果您认为实现细节非常有趣，可以成为Javadoc的一部分，您只需在Javadoc注释本身的一段中提供它们：

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

/**
*做点什么。
*
*实施细节：

*废话废话。。。
*

*/
公共无效剂量测定法（）{
// ...
}

据我所知，没有任何用于注释或备注的专用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
}

/**
*简要说明。方法的完整描述，一般不包括
*实施细节。
*
*注：附加信息，例如您的实施说明或备注。
*

*@param参数的输入说明
*@返回值的返回说明
* 
*@自版本
*@author作者姓名
*/
公共布尔值doSomething（字符串输入）
{
//你的代码
}

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

下面是一条javadoc注释，其中包括自定义标记“@note”：

要为上述内容生成javadoc，请按如下方式运行javadoc：

javadoc-tagnote:a:“note:”Quark.java

---

来源：

通过Java编程语言的第8次迭代，开发人员最终获得了三个附加标记，可以在代码文档中使用，并且应该满足您的需要：

@apiNote

、

@implSpec

和

@implNote

（例如，更详细的讨论请参见：）.

通常，如果打开（xml-）标记，应该在某个位置将其关闭。现在应该被认为是正确的。最好在你的答案中直接解释这些标签的用例（它们之间的区别是什么）。

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

    }