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

Question

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

Answer 1

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