將文件註解處理成 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 記錄程式碼 。
