私のクラスが外部ライブラリ(書かなかったもの)からよく書かれた外部インターフェイスを実装している場合、例えばAttributeConverter
からjavax.persistence
まで、私はオーバーライドメソッドを文書化する正しい方法を考えています。 @inheritDocまたはjavadoc以外のコメントブロックを使用するのか、ドキュメントが簡単に見つかる可能性があるので、まったくドキュメント化していないのでしょうか?Javadocあなたがソースを書いたものではない外部インターフェイスを実装しているクラスですか?
1
A
答えて
2
これは実行しようとしている内容によって異なります。あなた自身に尋ねなければならない最初の質問は次のとおりです。親Javadocに追加するものはありますか?
答えが「いいえ」の場合、これは意見に基づくものです。あなたがちょうどそれを残しておけば、@Override
を使う限り、Javadocの親が使用されます。その結果はnon-javadoc
のコメントが不必要になります。それはまだソースコードの目的を果たしています。 Should I use a "non-Javadoc" comment?
@inheritDoc
は、使用されている要素のみをコピーするので、この場合は役に立ちません。 documentationから:
法主説明または@return、@paramまたは@throwsタグコメントにインラインタグ{@inheritDoc}を挿入 - 対応継承主説明またはタグコメントはその場所にコピーされます。
親のドキュメントに何かを追加したい場合は、これが有効です。あなた自身のコメントのある時点で親文書を挿入するために使用します。
関連する問題
- 1. インターフェイスを実装していないインターフェイスの実装
- 2. クラスデザイン:別のインターフェイスを実装しているインターフェイスを実装しているクラス
- 3. クラスの内部イベントが内部インターフェイスのイベントを実装できないのはなぜですか?
- 4. Serializableインターフェイスを実装するクラスがインターフェイスのメソッドを実装しない理由を教えてください。
- 5. ジェネリックオブジェクトは、必要なインターフェイスを実装していてもキャストが必要です
- 6. 抽象クラスのない実装のインターフェイスですか?
- 7. ソースのないクラスのJavaDocドキュメントを生成するには?
- 8. Timersインターフェイスを実装していないjavascriptエンジン(ランタイム)はありますか?
- 9. 私のクラスが内部で宣言されたインタフェースを実装できないのはなぜですか?
- 10. Delphiでは、インターフェイスを実装していないオブジェクトにインターフェイスをバインドすることが可能です
- 11. Javaジェネリック:内部インターフェイスが(内部)スーパーインターフェイスから実装できないのはなぜですか?
- 12. 実装しているメソッドがJavaDocの解説を持っているかどうかは、実装するインターフェースにJavaDoc解説がある場合
- 13. 効率的で安定した外部ソートアルゴリズムの実装(cで書かれています)は何ですか?
- 14. JavaがArrayListクラスを使用してHashtable/HashMapクラスを実装していないのはなぜですか?
- 15. Iterableインターフェイスを実装するにはどうしたらいいですか?
- 16. Javaで外部クラスを使用していない内部クラスに問題がありますか?
- 17. MysqlConnectionPoolDataSourceソースをダウンロードして、Mavenでjavadocを見つけることができないのはなぜですか?
- 18. pyinstallerで作成したexeファイルが外部ソースを認識しない
- 19. クラスはいつインターフェイスを実装する必要がありますか?
- 20. C++。なぜ私はtraitクラスを使ってインターフェイスを実装できないのですか?
- 21. ジェネリックスがインターフェイスに基づいているインターフェイスを実装する
- 22. ArrayListとVectorがAbstractListクラスとして直接Listを実装している必要があるのは、既にListインターフェイスを実装していますか?
- 23. 私のクラスがIDisposableインターフェイスを実装していない場合、クラスがクラスとしてクラスを持っている場合は、C#
- 24. Runnableインターフェイスをスレッド実装クラスで実装する必要のない単純なJavaのスレッドシナリオ
- 25. 戻り値の型が外部インターフェイスであるネストされたインターフェイスメソッドを実装する方法は?
- 26. このインターフェイスがこのようにクラス内で実装されているのはなぜですか?
- 27. .NET - あなたはインターフェイスを越えてできますか?そしてインターフェイスを使用しない場合は
- 28. F#クラスはプライベートメンバーとしてインターフェイスを実装しています、なぜですか?
- 29. クラスはクラスを拡張してインターフェイスを実装できます
- 30. インターフェイスまたは実装内で変数を宣言していますか?