Java—将javadoc与方法注释一起使用的约定？

我有以下方法：

   @Override
   public boolean myMethod()
   {
      // do stuff
   }

如果我想为这个方法添加一个javadoc，那么在使用@Override注释（或任何其他注释）的同时，有没有关于如何添加的约定

我问这个问题的原因是因为我读到javadoc注释必须直接在方法之前（两者之间没有换行符），我不确定将javadoc注释直接放在@Override注释之上是否会把事情搞砸

比如说，这是一种传统的做法吗？这行吗

   /**
    * This is my method's javadoc comment.
    */
   @Override
   public boolean myMethod()
   {
      // do stuff
   }

---

是的，这条路是正确的，我还没有看到另一条路。是的，它是这样工作的。我没试过另一种方法

   /**
    * This is my method's javadoc comment.
    */
   @Override
   public boolean myMethod()
   {
      // do stuff
   }

---

但基本上我不会向重写另一个方法的方法添加javadoc注释，尤其是在实现接口时。标签

@inheritDoc

在这里很有用，可以轻松分发文档。但这是本例所特有的，您也可以添加其他注释。

是的，它将正常工作。例如，在openjdk中，他们在

@Deprecated

注释上使用javadoc。

我不同意不应记录重写的方法。对于实现的接口方法，这可能是正确的，但是被重写的类方法的文档可以说明方法的行为发生了什么变化。当然，使用

@inheritDoc

Javadoc标记可以避免很多输入，但是IMO文档不应该被忽略在重写方法上。基本上，我同意你的观点，因此更新了我的答案。但我认为javadoc是用来记录方法的功能，而不是记录方法是如何完成的。改变一件事情的完成方式是完全可以的，但是这样的改变不应该违反超类定义的契约，这将导致需要改变javadoc。这就是为什么我认为没有必要为每个方法都编写javadoc的原因。我想知道公约是什么，而不仅仅是它是否有效。