XML 檔 (Visual C++)

在 Visual C++ 中,您可以將批註新增至處理至 XML 檔檔的原始程式碼。 這個檔案便可以成為針對您程式碼中的類別建立文件之程序的輸入。

在 Visual C++ 程式碼檔案中,XML 檔批註必須直接位於方法或類型定義之前。 註解可以在下列案例中用來填入 IntelliSense QuickInfo 資料提示方塊:

  1. 當程式碼編譯為具有 WINMD 檔案的Windows 執行階段元件時

  2. 當原始程式碼包含在目前專案中時

  3. 在類型宣告和實作位於相同標頭檔中的程式庫中

注意

在目前的版本中,程式碼批註不會在範本上處理,或是包含範本類型的任何專案(例如,採用參數做為範本的函式)。 新增這類的註解,將會導致未定義的行為。

如需使用檔批註建立 XML 檔案的詳細資訊,請參閱下列文章。

如需下列資訊 請參閱
要使用的編譯器選項 /doc
您可以用來在文件中提供常用功能的標記 檔批註的建議標籤
編譯器會產生以識別您程式碼中之建構的識別碼字串 處理 XML 檔案
如何分隔文件標記 Visual C++ 檔標籤的分隔符號
從一或多個 XDC 檔案產生 XML 檔案。 XDCMake 參考
XML 與 Visual Studio 功能區之關聯性的資訊連結 Visual Studio 中的 XML

如果您需要將 XML 特殊字元放在文件註解的文字裡,必須使用 XML 實體或 CDATA 區段。

另請參閱

執行時間平臺的元件延伸模組