如何使用JavaDoc操作监听器

时间:2018-07-10 14:20:12

标签: java comments javadoc

我有一个ActionListener:

private ActionListener someAction = new ActionListener() {
    @Override
    public void actionPerformed(ActionEvent e) {
        System.out.println("Hello World");
    }
}

我将如何对JavaDoc进行评论。我想我有三种选择:

  • private ActionListener...上方添加我的评论
  • @Override上方添加我的评论
  • public void actionPerformed...上方添加我的评论

在哪里最好添加我的JavaDoc注释?

1 个答案:

答案 0 :(得分:1)

您不应记录匿名内部类,因为JavaDoc Tool会忽略它。

  

Javadoc工具不会直接记录匿名类-   是,其声明和文档注释将被忽略。   如果您要记录匿名课程,则正确的方法是   在其外部类的文档注释中,或其他紧密相关的文档   课。

来自Java Docs