オーバーロードメソッドでJavadocを書き込むDRY方法


9

JavadocをDRYで記述したい。しかし、Javadocに関するOracleのドキュメントでは、オーバーロードメソッドのコメントに同じことを再度記述しています。繰り返しは避けられませんか?

回答:


3

{@inheritDoc}スーパークラスからメソッドをオーバーライドしたり、インターフェース定義のメソッドを実装したりするときは、Javadocコメントのあちこちにディレクティブを振りかけます。

これは少なくとも私にとってはうまく機能し、ソースコードでの繰り返しを回避します。必要に応じて、特定の情報を特定のJavadocコメントに追加できます。適切なIDEで必要なのは、関連付けられた識別子名にカーソルを合わせるだけで、レンダリングされたJavadocに参照などを表示する場合、Javadocコメント自体が問題になることはないと思います。


2

ドキュメント化のポイントは、アイテムの将来のユーザーを明らかにすることです。これは、部分的には作者の便宜のためです。そのため、誰かが事がどのように機能するかを理解できない場合は、彼または彼女に連絡する必要はありません。しかし、ほとんどの場合、それを使用またはサポートする必要がある人々の利益のためです。

そのため、著者にとっての便宜とは対照的に、ポイントは明快でなければなりません。あなたは本質的に怠惰で自分自身を繰り返すことができなかったので、人々があなたのAPIドキュメントを探し回るのを期待することはできません。それを吸ってください--Javadocは繰り返しになります。

とは言っても、理由はありません。賢いのであれば、マーカーやその他の基準に基づいてコードにコメントを貼り付けるプログラムを作成することはできません。それは価値があるよりももっと面倒かもしれません。か否か。


4
いいえ、繰り返さないでください。すべてを同期させるためのオーバーヘッドはそれだけ多くなります。オーバーロードされた実装に関する新しい情報がある場合は、それだけを記述します。あるタイプのユーザーがそのスーパータイプのjavadocを見ることを期待するのは理にかなっていると思います。Eclipseなどのツールを使用すると、非常に簡単に見ることができます。
Dawood ibnカリーム2012年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.