共用方式為

建議可用於文件註解的 XML 標記 (Visual Basic)

  • 發行項

Visual Basic 編譯器會將您程式碼中的文件註解處理為一個 XML 檔案。您可以使用其他工具，將 XML 檔案處理成文件。

程式碼建構 (例如型別與型別成員) 上允許 XML 註解。對於部分型別而言，僅有型別的其中一個部分可以具有 XML 註解，但是在註解成員方面則沒有限制。

注意事項注意事項

文件註解不可套用至命名空間。原因在於一個命名空間可以橫跨多個組件 (Assembly)，但不一定需要同時載入所有組件。

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

<c>

<code>

<example>

<exception>1

<include>1

<list>

<para>

<param>1

<paramref>

<permission>1

<remarks>

<returns>

<see>1

<seealso>1

<summary>

<typeparam>1

<value>

(1 編譯器會驗證語法。)

注意事項注意事項

如果您要在文件註解的文字中顯示角括弧，請使用 &lt; 和 &gt;。例如，字串 "&lt;text in angle brackets&gt;" 會顯示為 <text in anglebrackets>。

請參閱

工作

HOW TO：在 Visual Basic 中建立 XML 文件

參考

/doc

概念

使用 XML 在程式碼中加入文件 (Visual Basic)