/doc

將文件註解處理成 XML 檔案。

/doc[+ | -]
' -or-
/doc:file

引數

詞彙	定義
+ | -	選擇項。 指定 + 或只是 /doc，讓編譯器產生文件資訊，並將其置於 XML 檔案。 指定 - 是未指定 /doc 的對等用法，因而無法建立文件資訊。
file	如果使用 /doc:，則為必要項。 指定 XML 輸出檔，它會填入編譯之原始程式碼檔內的註解。 如果檔案名稱包含空格，請將名稱放在引號 (" ") 中。

備註

/doc 選項會控制編譯器是否產生含有文件註解的 XML 檔案。 如果使用 /doc:file 語法，則 file 參數會指定 XML 檔案的名稱。 如果使用 /doc 或 /doc+，則編譯器會從編譯器正在建立的可執行檔或程式庫中取得 XML 檔案名稱。 如果使用 /doc- 或未指定 /doc 選項，則編譯器不會建立 XML 檔案。

在原始程式碼檔案中，文件註解可在下列定義之前：

• 使用者定義的型別 (例如，類別或介面)

• 成員 (例如，欄位、事件、屬性、函式或副程式)。

若要將產生的 XML 檔案與 Visual Studio IntelliSense 功能搭配使用，請讓 XML 檔案的檔名與想要支援的組件相同。 確定 XML 檔案與組件位於相同目錄中，以便在 Visual Studio 專案中參考組件時，也會找到 .xml 檔案。 若要讓 IntelliSense 針對專案或專案所參考之專案內的程式碼運作，不需要 XML 文件檔案。

除非使用 /target:module 進行編譯，否則 XML 檔案會包含標記 <assembly></assembly>。 這些標記會指定檔案名稱，此檔案含有編譯輸出檔的組件資訊清單。

請參閱建議可用於文件註解的 XML 標記 (Visual Basic)，以取得從程式碼中註解產生文件的方法。

若要在 Visual Studio 整合式開發環境中設定 /doc

在 [方案總管] 中選取專案。 在 [專案] 功能表上，按一下 [屬性]。 如需詳細資訊，請參閱專案設計工具簡介。 按一下 [編譯] 索引標籤。 在 [產生 XML 文件檔案] 方塊中設定值。

範例

請參閱使用 XML 在程式碼中加入文件 (Visual Basic) 中的範例。

請參閱

概念

使用 XML 在程式碼中加入文件 (Visual Basic)

其他資源

Visual Basic 命令列編譯器