從文件註釋生成 XML

要從程式碼中的文件註釋生成 XML 文件檔案，請將/doc 選項與 csc.exe C#編譯器一起使用。

在 Visual Studio 2013/2015 的“ 專案 - > 屬性 - > 構建 - > 輸出”中，選中 XML documentation file 核取方塊：

在構建專案時，編譯器將生成一個 XML 檔案，其名稱對應於專案名稱（例如 XMLDocumentation.dll - > XMLDocumentation.xml）。

在另一個專案中使用程式集時，請確保 XML 檔案與正在引用的 DLL 位於同一目錄中。

這個例子：

/// <summary>
/// Data class description
/// </summary>
public class DataClass
{
    /// <summary>
    /// Name property description
    /// </summary>
    public string Name { get; set; }
}

/// <summary>
/// Foo function
/// </summary>
public class Foo
{
    /// <summary>
    /// This method returning some data
    /// </summary>
    /// <param name="id">Id parameter</param>
    /// <param name="time">Time parameter</param>
    /// <returns>Data will be returned</returns>
    public DataClass GetData(int id, DateTime time)
    {
        return new DataClass();
    }
}

在 build 上生成這個 xml：

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>XMLDocumentation</name>
    </assembly>
    <members>
        <member name="T:XMLDocumentation.DataClass">
            <summary>
            Data class description
            </summary>
        </member>
        <member name="P:XMLDocumentation.DataClass.Name">
            <summary>
            Name property description
            </summary>
        </member>
        <member name="T:XMLDocumentation.Foo">
            <summary>
            Foo function
            </summary>
        </member>
        <member name="M:XMLDocumentation.Foo.GetData(System.Int32,System.DateTime)">
            <summary>
            This method returning some data
            </summary>
            <param name="id">Id parameter</param>
            <param name="time">Time parameter</param>
            <returns>Data will be returned</returns>
        </member>
    </members>
</doc>