フィールドごとに 1 回 Javadoc コメントを記述し、getter および setter メソッドで既存のフィールドの Javadoc にアクセスしたいと考えています。
親メソッドのドキュメントを参照するためのタグがあることは知ってい{@inheritDoc}ますが、もちろん親メソッドではないフィールドのドキュメントを含めたいと考えています。
Javadocで「繰り返さない」ことは可能ですか?
質問する
1732 次
3 に答える
2
getter に javadoc コメントを追加{@link MyObject#get..()}し、フィールドに a を追加します。
そのため、API/オブジェクトのユーザーにとっては読みやすく、私 (または別の開発者) は、より多くの情報を取得したい場合は、プライベート フィールドにカーソルを合わせるだけです。
于 2013-09-11T07:01:49.183 に答える
2
以外の@see方法はわかりません。
ただし、内部ドキュメントを生成している場合は、getter/setter をドキュメント化する必要はありません。外部ドキュメントを生成している場合は、とにかくプライベート プロパティをドキュメント化しません。
(正直に言うと、ある時点で、Java ソース コードを処理し、Java ツール チェーンのさまざまな制限のためにこのような魔法のようなことを行う、かなり見事なスクリプトなどのセットを持っていました。しばらく前にそれをあきらめました。 IDE の方がはるかに優れていますが、複数のファイルを単一のクラスに織り込むなど、非常に便利な機能もいくつかあります (偽の mixin やドキュメント マジックなどのようなものです)。
(実際、リンクされている Spoon プロジェクトは、私が行っていたものとかなり似ていますが、1.5 より前です。)
于 2012-05-29T19:29:52.117 に答える
1
Project Lombokを使用すると、この種のボイラープレートを回避できます。であっても、フィールド変数を文書化するだけでprivate、Lombok アノテーションが適切に文書化されたゲッターとセッターを生成します。
私にとって、このメリットだけでもコストに見合う価値があります。
于 2014-02-11T02:00:51.217 に答える