JavaDoc：在哪里添加笔记/备注到文档？

在C＃中编写代码时，总是发现标记remarks对于提供有关类或方法实现的注释或提供有关我正在实现的理论的信息非常有用。我现在正在使用Java，但我无法为此找到合适的JavaDoc标记。也许在Java中，你以不同的方式完成了这个任务，有人知道吗？JavaDoc：在哪里添加笔记/备注到文档？

来源

2011-04-11 tunnuz

据我所知，有ISN” •任何专用的Javadoc标签用于备注或备注。一般来说，Javadoc的第一句应该简要描述类/方法/字段。然后完整的描述应该遵循。如果你想包括任何注释，那么带有“注释”的专门段落就足够了。

/** 
* 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 
}

来源

2011-04-11 10:04:03 janhink

通常，如果你打开（xml-）标签，你应该关闭它们的某处。 – AlexS 2012-02-20 10:46:37

[This answer]（http://stackoverflow.com/a/34424961/2525313）现在应该被认为是正确的。 – Nicolai 2016-02-09 21:55:56

如果你想实现的细节是足够有趣是的Javadoc的一部分，你应该简单地为他们提供在Javadoc注释本身就是一个段落：

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

来源

2011-04-11 09:57:59

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

这里是一个javadoc注释，其中包括自定义标签 “@note”：

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

    }

为了产生这样的上述运行的javadoc的javadoc：

的javadoc -tag注意：： “注：” Quark.java

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

来源

2015-08-25 21:53:42 Naveen

使用Java编程语言的迭代8，开发人员最终获得了三个额外的标签，他们可以在其代码的文档–中使用这些标签，这些标签应该满足您的需求：@apiNote,@implSpec和@implNote（例如，参见更详细的讨论：blog.codefx.org/java/new-javadoc-tags/）。

来源

2015-12-22 21:46:20 fbahr

JavaDoc：在哪里添加笔记/备注到文档？

回答

相关问题