java - 如何使用 JavaDoc 编写 Action 监听器

Question

这个问题已经有答案了:

Javadoc for method of anonymous object (1 个回答)

已关闭 4 年前。

我有一个 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 注释？

Answer 1

您不应该记录匿名内部类，因为 JavaDoc 工具会忽略它。

The Javadoc tool does not directly document anonymous classes -- that is, their declarations and doc comments are ignored. If you want to document an anonymous class, the proper way to do so is in a doc comment of its outer class, or another closely associated class.

来自Java Docs