///クラス、フィールド、メソッド、またはプロパティを超えると、VisualStudioがXMLスタイルのコメントの作成を開始することを理解しています。
ただし、名前空間やライブラリのXMLコメントを追加するにはどこに行けばよいですか...
例えば：
それらのページが手動で作成されたのか、それとも適切な場所に追加されたXMLスタイルのコメントを介して自動的に作成されたのかわかりません。
2 に答える
3
これは、ドキュメントの生成に使用するツールによって異なります。では、文書化したい名前空間内でNDoc呼び出されるクラスを作成するだけで済みました。NamespaceDocそのクラスの XML コメントが使用されます。
質問には「sandcastle」のタグが付いているので、実際に使用していると思います。もしそうなら、このSOの答えは詳細を与えるべきです。
更新: OK、私は (同じスレッドで) どうやら Sandcastle が NamespaceDoc クラスも理解していることを見ました。誰かがこの質問を重複として閉じたいと思うかもしれません.
于 2011-05-20T07:01:03.913 に答える
0
xmlファイルを生成するには、プロジェクトのプロパティでそれをオンにする必要があります。これは、プロジェクトのプロパティXML documentation fileのタブにあるチェックボックスです。Build
オンにしてアセンブリを再コンパイルすると、そのアセンブリと同じ名前のxmlファイルがアセンブリの横に表示されます。
次に、sandcastleなどのツールを使用して、コードのヘルプファイルを作成できます。sandcastleは、実際には、ヘルプファイルを生成するプロセス全体をカスタマイズするために使用できるツールのセットです。このパスでは、サンドキャッスルのヘルプファイルとチュートリアルをよく読む必要があります。
サンドキャッスルインストールのexamplesフォルダーに埋め込まれているツールもあります。このツールを使用すると、ヘルプファイルをすばやく生成できますが、カスタマイズは少なくなります。
以前は、「DocProject」というVisualStudioプラグインをしばらく使用していました。それがまだアクティブかどうかはわかりませんが、興味があればcodeplexで見つけることができます：http：//docproject.codeplex.com/
Microsoftによると、参照しているMSDNの例は///、ソースからタグを抽出することによって作成されたものではありませんが、プログラマーとドキュメンターの部門を分割することと関係があります。
于 2011-05-19T21:18:06.930 に答える