Question

在以下代码中：

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方法相关联？仅仅是因为注释就在方法声明之前吗？

Answer 1

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

尽管据我所知，并没有明确说明，但是它是从JavaDoc Tool的工作原理的描述中得出的，请参见How to Write Doc Comments for the Javadoc Tool

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

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


Java类的源代码文件（.java）-这些文件包含类，接口，字段，构造函数和方法注释。

[...]

和

文档注释使用HTML编写，并且必须在类，字段，构造函数或方法声明之前。

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

1 个答案: