XMLドキュメンテーションコメントとのインタフェース実装クラス(es)[定休日]
https://stackoverflow.com/questions/750856
-
09-09-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
Russian質問
私は文書に組み立て用 XMLドキュメンテーションコメント, から chm ファイルを使用して作成し 設.
組み立てを含む、さまざまなインターフェイス、それぞれが実施するワンクラスマシナリオこれらは、WCFサービス
を追加した書面、本当にありがとう私にとって自動的に文書に関連する方法の実施ます。
解決
サンドキャッスルで、このようなautodocumentationをのための任意のサポートされないためにあるようです。 href="http://www.codeplex.com/SHFB" rel="nofollow noreferrer">サンドキャッスルヘルプファイルBuilderのの SHFBサイトから： サポートが含まれているため
あなたがすることができます。 を2回目の更新：のこの作業項目に応じて、inheritdocためのサンドキャッスル「サポート」SHFBツールです。ボトムライン私は、SHFBはあなたの問題を解決したとします。
他のヒント
いいえ FiXml.
クローニングコメントGhostDoc\AtomineerUtilsは確実に取り組んで、その重大な不利益、例えば:
- 時のコメントが変化を起こることが多いよう開発中), そのクローンがいません。
- い生産大量の重複している。使用している場合は、当 ソースコード解析ツールなど重複ファインダーチーム市まで 示が主になります。
していたので、あ <inheritdoc> タグ 設, なデメリットとの比較FiXml:
- 設作成HTMLヘルプファイルでない変更
.xmlファイル を含む抽出されたXMLコメントです。これらのファイルの使用により多くのツール 含まれています純反射板やクラスブラウザを行頭に付けできます。います。だいった、状況に応じた使い分け設だ継承した文書である。 - どの実装では迫力があります。E.g.をクリックしてください
<see ... copy="true" />.
見 どの <inheritdoc> 説明 詳細につきましては
スプレッドシートをFiXml:では、ポストプロセッサのXMLドキュメンテーションによC#です。います。として実装されており、MSBuild、それでも簡単に統合するプロジェクト.でのアドレス数の迷惑に関係する事例を書XMLドキュメンテーションにはこれらの言語:
- な支援を受け継ぎ、ドキュメンテーションベースのクラスまたはインターフェース。 I.。資料の他のオーバーライド会員は書き込まれるからでは普通で非常に望ましいを受け継ぐには少なくとも、がこれに取り組んでくれました。
- 【お問い合わせ先】石川挿入用書類テンプレート, "など、このタイプはシングルトン-その利用
<see cref="Instance" />性のみのインスタンスです。", も初期化の新しいインスタンス<CurrentType>クラスです。"
解決上の課題、以下の追加XMLのタグを提供してい:
<inheritdoc />, <inherited />タグ<see cref="..." copy="..." />属性<see/>タグです。
など GhostDoc のようなツールは、実装するクラスのドキュメントを生成することができますそれのキーボードショートカットを使用します。それは完全に自動ではありませんが、あまりにも多くのコピー＆ペーストを防ぐのに役立つ可能性があります。
おそらくそれはスクリプトでautomizedすることができます。
AtomineerUtilsはあなたのための自動生成コメントし、それが必要なのは情報を複製することで、あなたに手間の負荷を節約し、オーバーロードとオーバーライドされる基本クラスから既存のドキュメントをピックアップします。
