いくつかのメソッド間で同じxmlが使用されるクラスを作成しています。JavaDocコメントの重複の回避
/**
* Sample Response:
* <xmp>
* <myXML>
* <stuff> data </stuff>
* </myXML>
* </xmp>
*/
CommonXML Method1();
/**
* Sample Submission:
* <xmp>
* <myXML>
* <stuff> data </stuff>
* </myXML>
* </xmp>
*/
void Method2(CommonXML xml);
XMLの変更は、私はむしろ影響を受けるメソッドのJavadocのすべてを更新するよりも、修正するための一つのリソースを持っている場合、私は私のように、ドキュメントを書きたいと思います。
誰でもこれを達成する方法を知っていますか？あなたのドキュメントを読んだことがない
理由：
/**
* Returns an XML file conforming to the CommonXML schema, available here
* (link-to-schema).
**/
をあなたのXMLを更新した場合次に、あなたは自分のスキーマを更新しますか？
JavaDocガイドラインに従って期間を指定して文を終了してください。 –
注目と修正。 – JohnnyO
@seeを使用して他の方法を参照するとどうなりますか？
私はこの問題のオブジェクトを取り上げる方法ではなく、ドキュメントがあなたのシステムが何であるかを文書化するためにテストを使用することは時間の無駄だと考えています。タイプ。
+1は、CommonXMLオブジェクトを文書化するための提案です（そして思考文書のためのほぼ-1は時間の無駄です）。ドキュメント化されていないコードをデバッグすることは何も面倒なことはありません。 ）ドキュメンテーションは開発者のファーストクラスの義務である！） –
開発者の90％がコードを読んでいると言われているので、「ドキュメンテーション」時間を費やしてコードをリファクタリングすることが好ましいそれは本当に理解しやすい。しかし、私は人々が強くそのようなことについて意見を持っていることを理解しています！ – time4tea
コメントは、私が作り出すものの消費者によって使われるので、コードに頼ることは、私が扱える解決策ではありません。 – TERACytE
他で定義されている仕様を繰り返すためにJavadocを使用すべきではありません。 を参照してください。
これを行うには、Doclavaのinclude or sample tagを使用できます。これらのタグは、サンプルテキストを任意のファイルから出力javadoc htmlにコピーします。 @includeタグは、指定されたファイルからテキストを逐語的にコピーします。 @sampleタグは、いくつかの変更を加えて、指定されたファイルからテキストをコピーします。
私はjava-docを作成するために1つのクラスを指定できると思います。しかしGoogleへの必要性。 :) – Nishant
私はJavadocで変数定義を再利用したいと思うのはよくある問題です。ここのOPがXML文書について質問するという事実は、それがどれほど共通しているのかを隠しているという事実です - http://stackoverflow.com/questions/7021696/javadoc-reusable-parameter-valuesおよびhttp://stackoverflow.com/questions/1036565/isを参照してください。 -it-possible-to-re-use-javadoc内のparam-descriptions- –