共用方式為

建議使用的文件註解標籤

  • 發行項

MSVC 編譯器會處理常式代碼中的檔批註，以為每個編譯的原始程式檔建立 XDC 檔案。 然後，xdcmake.exe 會處理 XDC 檔案以建立 XML 檔檔。 處理 XML 檔案以建立檔是需要在您的網站實作的詳細資料。

標記是在類型和類型成員這類建構上處理。

標記必須緊接在類型或成員之前。

注意

檔批註無法套用至命名空間或屬性和事件的行外定義;檔批註必須位於類別內宣告上。

編譯器會處理任何為有效 XML 的標記。 下列標記提供使用者文件中的常用功能：

<c>
<code>
<example>
<exception>1
<include>1
<list>
<para>
<param>1
<paramref>1
<permission>1
<remarks>
<returns>
<see>1
<seealso>1
<summary>
<value>

  1. 編譯器會驗證語法。

在目前版本中，MSVC 編譯器不支援 <paramref> ，這是其他 Visual Studio 編譯器支援的標記。 Visual C++ 可能在未來的版本支援 <paramref>。

另請參閱

XML 檔