共用方式為


使用 XML 記錄程式代碼 (Visual Basic)

在 Visual Basic 中,您可以使用 XML 記錄程式代碼。

XML 文件註解

Visual Basic 提供簡單的方法來自動建立專案的 XML 檔。 您可以為類型和成員自動產生 XML 基本架構,然後為每個參數提供摘要、描述性檔,以及其他備註。 使用適當的設定,XML 文件會自動生成至與專案同名的根 XML 檔案。 如需設定產生 XML 檔檔的相關信息,請參閱 -doc 編譯程式選項GenerateDocumentationFile MSBuild 屬性

XML 檔案可以以 XML 格式取用或進行其他操作。 此檔案位於與項目的輸出 .exe 或 .dll 檔案相同的目錄中。

XML 檔案開頭為 '''。 這些批注的處理有一些限制:

  • 文件必須是格式正確的 XML。 如果 XML 格式不正確,就會產生警告,而且檔檔包含批注,指出發生錯誤。

  • 開發人員可以自由建立自己的一組標記。 建議使用一組標籤(請參閱 XML 批註標籤)。 某些建議標籤具有特殊意義:

    • <param> 標籤用於描述參數。 如果使用,編譯程式會確認參數存在,而且檔中會說明所有參數。 如果驗證失敗,編譯程式會發出警告。

    • cref屬性可以附加至任何標記,以提供程式碼項目的參考。 編譯程式會驗證此程式代碼專案是否存在。 如果驗證失敗,編譯程式會發出警告。 編譯程式在尋找 屬性中所述Imports的類型時,也會遵守任何cref語句。

    • <summary> IntelliSense 在 Visual Studio 中使用此標籤來顯示關於某個類型或成員的額外資訊。

如需了解如何使用文件註解建立 XML 檔案的詳細資訊,請參閱下列主題:

另請參閱