2012-05-12 60 views
18

Birçok .NET derlemesine bir XML dosyası eşlik eder. için bu XML nedir.NET derleme dosyasıyla birlikte gelen XML dosyası nedir?

<?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> 

: Örneğin, System.Web.WebPages.Razor.dll aşağıdaki içerdiğini birlikte System.Web.WebPages.Razor.xml ile geliyor? Çalışma zamanında buna ihtiyacım var mı?

cevap

13

Bu kod yorum/intellisense dosyasıdır ve IDE (yani Visual Studio) tarafından kullanılmaz, çalışma zamanı değil - tüm genişletilmiş yöntem/parametre/tür açıklamaları vb.

İkilinizle dağıtmanıza gerek yoktur, ancak bunlara da zarar vermez. Aynı zamanda IDE'de tamamen isteğe bağlı - sadece: intellisense onsuz sizin için daha az bilgilendirici olacaktır (sadece isimleri ve türleri gösterecektir - daha ayrıntılı yöntem açıklamaları değil).

Kendi kütüphanenizde kendi kod yorumlarınızı yazmak ve proje dosyalarındaki XML dosyası oluşturmayı etkinleştirmek için /// sözdizimini kullanın.

4

Bu, bu derlemenin XML belgelendirmesidir. Bu yalnızca VisualStudio'daki Intellisense için kullanılır. Detaylar için this answer'a bakın.