共用方式為

-doc

  • 發行項

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

語法

-doc[+ | -]

或

-doc:file

引數

詞彙 定義
+ | - 選擇性。 指定 + 或只指定 -doc，編譯器就會產生文件資訊，並將其置放在 XML 檔案中。 指定 - 相當於未指定 -doc，因此不會建立任何文件資訊。
file 如果使用 -doc:，則為必要項。 指定輸出 XML 檔案 (將會對該檔案填入來自編譯原始程式碼檔案的註解)。 如果檔案名稱包含空格，請以引號 (" ") 括住該名稱。

備註

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

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

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

除非使用 -target:module 進行編譯，否則 XML 檔案會包含 標籤 <assembly></assembly>。 這些標籤可指定一個檔案名稱，而其內包含編譯的輸出檔案之組件資訊清單。

如需從程式碼的註解產生文件的方法，請參閱 XML 註解標籤。

在 Visual Studio 整合式開發環境中設定 -doc
1.在 方案總管中選取專案。 按一下 [專案] 功能表上的 [屬性]。
2.按一下 [編譯] 索引標籤。
3.在 [產生 XML 文件檔案] 方塊中，設定值。

範例

如需範例，請參閱使用 XML 記錄程式碼。

另請參閱