Java - 使用javadoc和方法注释的约定？

Question

我有以下方法：

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

如果我想为此方法添加一个javadoc，是否有关于如何执行此操作以及@Override注释（或任何其他注释）的约定？

我问的原因是因为我已经读过javadoc注释必须直接在方法之前（两者之间没有换行符），而且我不确定是否将javadoc注释直接放在@Override注释之上会弄乱东西起来。

这是传统的做法吗？这有用吗？

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

Answer 1

是的，这种方式是正确的方式，我没有看到相反的方式。是的，这种方式有效。没有尝试相反的方式。

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

但基本上我通常不会向覆盖其他方法的方法添加javadoc注释，尤其是在实现接口时。标记@inheritDoc在这里很有用，可以毫不费力地分发文档。但这是特定于此示例的，您也可以添加其他注释。

Answer 2

是的，它会正常工作。例如，在openjdk的source code of java.lang.String中，他们在@Deprecated注释的顶部使用了javadoc。