☰

Java - メソッド注釈と一緒に javadoc を使用する規則は? [重複] 質問する

tag-icon • tag-icon java annotations javadoc
Java - メソッド注釈と一緒に javadoc を使用する規則は? [重複] 質問する

次の方法があります:

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

このメソッドの javadoc を追加する場合、@Override アノテーション (またはその他のアノテーション) とともにこれを行う方法に関する規則はありますか?

私が質問する理由は、javadoc コメントはメソッドの直前に置く必要がある (2 つの間に改行を入れない) と読んだのですが、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大きな労力をかけずにドキュメントを配布するのに役立ちます。ただし、これはこの例に固有のものであり、他の注釈を追加することもできます。

おすすめ記事