JavaDoc：在哪里向文档添加注释/备注？

coding-style java javadoc

2022-08-31 20:32:23

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

答案 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
}

答案 2

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