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

java annotations javadoc

2022-09-02 10:11:43

我有以下方法：

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

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

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

例如，这是传统的方法吗？这有效吗？

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

答案 1

是的，这种方式是正确的方式，我还没有看到相反的方式。是的，它以这种方式工作。没有尝试相反的方式。

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

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

答案 2

是的，它将正常工作。例如，在 openjdk 的 java.lang.String 源代码中，他们在注释之上使用 javadoc。@Deprecated