2012-05-12 9 views
18

多くの.NETアセンブリにはXMLファイルが添付されています。例えば、System.Web.WebPages.Razor.dllは以下が含まれているSystem.Web.WebPages.Razor.xmlと一緒に来る:.NETアセンブリファイルと一緒に提供されるXMLファイルとは何ですか?

<?xml version="1.0" encoding="utf-8" ?> 
<doc> 
    <assembly> 
     <name>System.Web.WebPages.Razor</name> 
    </assembly> 
    <members> 
     <member name="T:System.Web.WebPages.Razor.PreApplicationStartCode" /> 
     <member name="M:System.Web.WebPages.Razor.PreApplicationStartCode.Start" /> 
     <member name="T:System.Web.WebPages.Razor.RazorBuildProvider" /> 
     <member name="M:System.Web.WebPages.Razor.RazorBuildProvider.#ctor" /> 
     Much more elements follow... 
    </members> 
</doc> 

ため、このXMLとは何ですか?実行時にそれが必要ですか?

答えて

13

コードコメント/インテリセンスファイルで、実行時ではなくIDE(つまりVisual Studio)で使用されます。すべての拡張メソッド/パラメータ/タイプの説明などです。

バイナリで展開する必要はありませんが、害はありません。これはIDEでも完全にオプションです。ちょうどintellisenseはそれなしでは情報が少なくなります(より詳細なメソッドの説明ではなく、名前と型などが表示されます)。

独自のライブラリでは、独自のコードコメントを記述し、project-propertiesでXMLファイルの生成を有効にするには、///構文を使用します。

4

これは、そのアセンブリのXMLドキュメントです。これはVisualStudioのIntellisenseでのみ使用されます。詳細はthis answerを参照してください。

関連する問題