2012-05-08 11 views
1

私は広範なラッパーライブラリを開発しています。ラッパーは、基礎となる関数に1対1を対応付けていないので、関数呼び出し階層を文書化すると有益です。関数呼び出し階層の文書化

これを達成するための最良の方法は何ですか?理想的には、XMLコメントに統合され、可読/検索可能なドキュメントを生成するために使用されるものです。しかし、実用的な解決策は大歓迎です。

答えて

0

サンドキャッスル概念トピックは、例えば、XMLコメントの中に埋め込むことができるブロック要素を持っている。、表、一覧表示されます。これらの要素を使用してフローシーケンスを列挙する必要があります。

代わりに、VS2010またはNDependのような他のツールの建築ツールを使用して、コールグラフ、シーケンス図を生成し、HTMLタグを使用して文書にこれらの画像を埋め込むことができます。

+0

最初の提案は、私が探しているように聞こえます。あなたは私に少しのポインタを与えることができますか?トピックをグーグルで探すのに問題があります。 –

+0

私はこれを見つけました:http://www.codeproject.com/Articles/22539/Sandcastle-Conceptual-Help-Quick-Start – ideafountain

+0

コードでコメントを作成したいのであれば、カスタムタグを追加するこのリンクを試してください:http:// blogs.msdn.com/b/sandcastle/archive/2006/11/22/supporting-custom-tags-in-sandcastle.aspx – ideafountain

関連する問題