javadoc 如何知道每个文档注释用于哪种方法？

Posted 2023-02-21

【中文标题】javadoc 如何知道每个文档注释用于哪种方法？

【英文标题】：How does the javadoc know which method each documentation comment is for?

【发布时间】：2019-05-14 17:25:34

【问题描述】：

在以下代码中：

public class Rectangle 
    private double length;
    private double width;

    /**
     * The setLength method stores a value in the
     * length field.
     * @param len The value to store in length.
     * 
     */

    public void setLength(double len)
        length  = len;
    

javadoc 如何将我的评论与setLength 方法相关联？仅仅是因为注释就在方法声明之前吗？

【问题讨论】：

你可以试试看...写2个JavaDoc cmets中间不带方法，下面写个方法，然后看看有没有被拿，如果是，是哪个……跨度>

【参考方案1】：

是的，确实只是因为注释就在方法声明之前。

虽然据我所知没有明确说明，但它遵循 JavaDoc 工具如何工作的描述，请参阅How to Write Doc Comments for the Javadoc Tool

具体来说，关于Source Files的部分：

Javadoc 工具可以生成来自四个不同的输出 “源”文件的类型：

Java 类 (.java) 的源代码文件 - 这些文件包含类、接口、字段、构造函数和方法 cmets。 [...]

和

文档注释是用 html 编写的，必须在类、字段、构造函数或方法声明之前。