XML 文件註解 (C# 程式設計手冊)

在 Visual C# 中,您可以為程式碼建立文件,方式是在相關的程式碼區塊前面,直接將 XML 標記以特殊註解欄位的形式加入原始程式碼中。 例如:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

當您使用 /doc 編譯時,編譯器將會搜尋原始程式碼中的所有 XML 標記,然後建立 XML 文件檔。 若要依據編譯器產生的檔案建立最後的文件,您可以建立自訂工具,或者是使用 Sandcastle 這類的工具。

注意事項注意事項

XML 文件註解並不是中繼資料,這些註解不會包含在編譯的組件內,因此不能透過反映存取。

本章節內容

相關章節

如需詳細資訊,請參閱:

C# 語言規格

如需詳細資訊,請參閱 C# 語言規格。 語言規格是 C# 語法和用法的決定性來源。

請參閱

概念

C# 程式設計手冊