1

私の XML コメントをコード ベースから抽出し、それらを XML ファイルに入れることができるツールはありますか? 私は自分で別のファイルを維持したくありません。完了したら XML を生成し、ソース コードからコンテンツを削除したいと考えています。

4

2 に答える 2

3

あなたが求めているアプローチの問題は、コードを変更するとすぐに、「プリコンパイルされたxml」がそれと同期しなくなることです（または、このハプニングを止めたい場合は、xmlファイルを次のように編集する必要がありますこれは、元の XML コメントを見るよりも 1000 倍悪いことです!)。ドキュメント コメントを受け入れて、それらを使用することで得られる多くの利点 (直接的および間接的) を最大限に活用することを検討する必要があると思います。ただし、実行したい場合は、XML doc 出力の生成を有効にし、プロジェクトを再構築し、bin\debug または bin\release フォルダーから XML ファイルをコピーして、スラッシュと書き込みを開始するだけです。

ただし、他にも破壊的でないオプションがあります。

  • [ツール] > [オプション] : [環境] > [フォントと色] で、ドキュメント コメントの構文の色分けを変更できます。淡い色を使用すると、コメントが背景にフェードインします。

  • おそらく、コメントがもっときちんとしていれば、目から血が出るほどではないでしょう。私はアドイン ( Atomineer Pro Documentation ) を作成しました。これは、doc コメントに包括的な書式設定オプションを適用して、コメントをより見やすくすることができます。テキスト ブロック、オプションのワードラップなど。または、XML タグが本当に問題である場合は、コメントを不快感の少ない形式に変換できます (Doxygen、JavaDoc、Qt、および XML ドキュメントをサポートしています)。

  • 私のアドインには、VS の「アウトライン」機能を使用してドキュメント コメントを非表示にするオプションもあります (必要に応じて、またはドキュメントが開かれるたびに)。基本的にドキュメントのコメントを非表示にすることで、症状の一部が軽減される場合があります。

  • 理論的には、ドキュメント コメントの表示を変更してマークアップを削除し、より wysiwyg な表現を表示できる VS2010 拡張機能を作成することは可能です。私は何も聞いていませんが、あなたを助ける何かが今そこにあるかもしれません.

于 2012-04-18T21:59:39.800 に答える
1

/docスイッチを使用して Visual Studio コンパイラを使用できます。このオプションは、Buildタブのプロジェクト プロパティでも使用でき、名前はXML documentation fileです。コメントを含む別の XML ファイルが生成され、IntelliSense で使用できます。これは、コンパイル済みのアセンブリを使用法コメント (ユーティリティ ライブラリ) と共に配布する場合に使用することを意図しています。サンドキャッスルというものもあります。このリンクを確認してください

NDocもご覧ください。XML コメントに基づいてコード ドキュメントが生成されます。オープンソースです。

コメントの邪魔にならないようにする方法を詳しく調べている場合は、コメントの色をより淡い色に変更すると便利です([ツール] -> [オプション] -> [環境] -> [フォントと色])。マクロを使用してすべてのコメントを折りたたむこともできます。

とにかく、コードにコメントを残すことをお勧めします。これにより、コードがより保守しやすくなります。

于 2012-04-18T21:54:29.980 に答える