Share via


/doc (處理文件註解) (C/C++)

會讓編譯器處理原始程式檔中的文件註解,並為每一個有文件註解的原始程式檔建立 .xdc 檔。

/doc[name]

引數

  • name
    編譯器將建立的 .xdc 檔案名稱。 只有在編譯中已傳遞了一個 .cpp 檔案時,才會有效。

備註

.xdc 檔是以 xdcmake.exe 處理過並送入 .xml 檔中。 如需詳細資訊,請參閱 XDCMake Reference

您可以將文件註解加入原始程式檔。 如需詳細資訊,請參閱Recommended Tags for Documentation Comments (Visual C++)

不過,/doc/clr:oldSyntax 不相容。 如需詳細資訊,請參閱 /clr (Common Language Runtime 編譯)

若要將所產生的 .xml 檔案搭配 IntelliSense 運用,就必須讓這個 .xml 檔案和您所要支援的組件具有相同名稱,並將這個 .xml 檔案放入與該組件相同的目錄中。 在 Visual Studio 專案中參考此組件時,就可以同時找到 .xml 檔案。 如需詳細資訊,請參閱使用 IntelliSense提供 XML 程式碼註解

若要在 Visual Studio 開發環境中設定這個編譯器選項

  1. 開啟專案的 [屬性頁] 對話方塊。 如需詳細資訊,請參閱 HOW TO:開啟專案屬性頁

  2. 展開 [組態屬性] 節點。

  3. 展開 [C/C++] 節點。

  4. 按一下 [輸出檔] 屬性頁。

  5. 修改 [產生 XML 文件檔] 屬性。

以程式設計方式設定這個連結器選項

請參閱

參考

編譯器選項

設定編譯器選項