使用 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
屬性可以附加至任何標記,以提供程式碼項目的參考。 編譯器會驗證此程式碼項目存在。 如果驗證失敗,則編譯器會發出警告。 編譯器在尋找cref
屬性所描述的型別時,也會遵守任何Imports
陳述式。Visual Studio 中的 IntelliSense 使用 <summary> 標籤來顯示型別或成員的其他資訊。
相關章節
如需降利瞭解如何建立包含文件註解 XML 檔案,請參閱下列主題: