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

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

在型別和型別成員這類程式碼建構上會允許使用 XML 註解。 對於部分型別，只有一個部分的型別可以有 XML 註解，不過對於註解其成員沒有限制。

注意

文件註解不能套用至命名空間。 原因是一個命名空間可能跨越數個組件，而且並非所有組件都必須同時載入。

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

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

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

注意

如果您想要讓角括弧出現在文件註解文字中，請使用 < 和 >。 例如，字串 "<text in angle brackets>" 會顯示為 <text in angle brackets>。

另請參閱

• 使用 XML 加入程式碼註解
• -doc
• 如何：建立 XML 文件