適切な ms xml ドキュメント タグを使用して、すべてのコードにコメントを付けました。コメントされたすべてのコードの HTML のみ (または pdf) のドキュメントを生成するにはどうすればよいですか? サンドキャッスルをダウンロードしましたが、次のステップに進む方法がわかりません。ありがとう！
2 に答える
5
ndoc http://ndoc.sourceforge.net/を見ることができます
基本的に、プロジェクトのプロパティで XML ドキュメントをオンにする必要があります。プロジェクトを右クリックしてプロパティを選択し、[ビルド] タブに移動して、[XMLDocumentation] チェックボックスをオンにします。
これにより、xml ファイル (html ではない) が生成されます。次に、XSLT スタイルシートを使用して xml ファイルを変換 (または解析) する必要があります。それがnDocの出番です。
于 2011-03-07T07:53:59.210 に答える
2
Sandcastle ( ndocの後継) は優れた文書化ツールですが、皮肉なことに、それを簡単かつ効果的に使用する方法は十分に文書化されていません。Sandcastle に直接アクセスしようとするのではなく、 Sandcastle Help File Builder (SHFB)または同様のプラットフォームを使用する必要があります。(太陽のことを考えてみてください: 周りにあるのは素晴らしいことですが、強力なサングラスなしで太陽を直接見たくはありません :-) 次に問題はSHFB をどのように使用するかになります。
私の 2010 年 9 月の記事、Taming Sandcastle: A .NET Programmer's Guide to Documenting Your Codeでは、何をする必要があるかを詳しく説明し、遭遇する可能性のある多くの潜在的な落とし穴を指摘しています。2010 年 10 月には、SHFB の XML ドキュメント コメント レキシコンをまとめた1 ページのウォール チャートを作成しました。
この記事のための私の調査から、他の有用なリソースの完全なリストを以下に示します。
- Eric Woodruff のSandcastle ヘルプ ファイル ビルダー ドキュメント(SHFB クリエーター)
- C# プログラミング ガイド:ドキュメント コメントの推奨タグ(MSDN)
- うーん。Eric Brunsen のXML ドキュメンテーション コメント ガイド(Dynicity)
- Anson Horton のC# による XML ドキュメント(Microsoft C# Compiler Program Manager)
于 2011-03-07T17:03:28.757 に答える