建议的文档注释标记(C# 编程指南) - C# 编程指南

返回介绍

建议的文档注释标记(C# 编程指南)

发布于 2019-11-12 字数1260 浏览 990 评论 0

C# 编译器将代码中的文档注释处理到 XML 文件中。需要在您的站点实现的一项具体内容是处理 XML 文件以创建文档。

在代码构造(如类型和类型成员)上处理标记。

说明:

文档注释不能应用于命名空间。

编译器将处理任何为有效 XML 的标记。下列标记提供了用户文档中常用的功能。

标记

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* 表示编译器验证语法。)

如果希望尖括号显示在文档注释的文本中,请使用 < 和 >。例如,<尖括号中的文本>。

请参见

任务

“XML 文档”示例

概念

C# 编程指南

参考

/doc(处理文档注释)(C# 编译器选项)XML 文档注释(C# 编程指南)

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!