多数の C# プロジェクトを含む vs2012 ソリューションがあります。ライブラリ全体に Sandcastle を使用してドキュメントを生成したいと考えています。
私はサンドキャッスルのドキュメントを見直してきましたが、プロジェクト全体のドキュメントを生成する方法が明確ではありません。
ソリューション全体でこれを達成するにはどうすればよいですか?
多数の C# プロジェクトを含む vs2012 ソリューションがあります。ライブラリ全体に Sandcastle を使用してドキュメントを生成したいと考えています。
私はサンドキャッスルのドキュメントを見直してきましたが、プロジェクト全体のドキュメントを生成する方法が明確ではありません。
ソリューション全体でこれを達成するにはどうすればよいですか?
Sandcastle Helpfile Builderを使用しました (Sandcastle を直接使用する代わりに)。
SHFB プロジェクトでは、<DocumentationSources>
セクションに複数の DLL+XML を指定できます。
ChrisWが示したように、Sandcastle Help File Builder(SHFB)を使用する必要があります。ただし、SHFBによって提供されるクリーンでシンプルなGUIを使用しても、きちんとしたプロフェッショナルなドキュメントセットを作成するために、検討する必要がある、または検討する必要のある問題がかなりあります。Simple-Talk.comで公開されている、さまざまな潜在的な落とし穴に関する私の経験を文書化した私の記事( " Taming Sandcastle:コードを文書化するための.NETプログラマーガイド")は、時間、労力、および苦痛を節約する可能性があります:-)。
記事を要約し、おそらくもっと興味を持ったら、 Simple-Talk.comで入手できるこの1ページのウォールチャートに、SHFBとSandcastleの完全な構文と使用法のガイドを掲載します。ここに一瞥があります: