Tệp XML đi kèm với tệp lắp ráp .NET là gì?

Question

Nhiều hội đồng .NET được đi kèm với một tệp XML. Ví dụ, System.Web.WebPages.Razor.dll đi kèm cùng với System.Web.WebPages.Razor.xml chứa sau:

<?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 này cho là gì? Tôi có cần nó trong thời gian chạy không?

Answer 1

Đây là tệp bình luận/tệp intellisense và được sử dụng bởi IDE (tức là Visual Studio), không phải là thời gian chạy - đó là nơi mà tất cả các mô tả/tham số/kiểu mở rộng vv xuất phát từ đó.

Bạn không cần phải triển khai nó với nhị phân của bạn, nhưng nó cũng không gây hại. Nó cũng hoàn toàn tùy chọn trong IDE - chỉ: intellisense sẽ ít thông tin hơn cho bạn mà không có nó (nó sẽ chỉ hiển thị tên và loại te, vv - không phải là mô tả phương thức chi tiết hơn).

Trong thư viện của riêng bạn, hãy sử dụng /// cú pháp để viết nhận xét mã của riêng bạn và cho phép tạo tệp XML trong thuộc tính dự án.

Answer 2

Đây là tài liệu XML cho hội đồng đó. Điều này chỉ được sử dụng cho Intellisense trong VisualStudio. Tham khảo this answer để biết chi tiết.