最新下载
热门教程
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
在C＃使用XML注释
时间：2022-07-02 11:43:05 编辑：袖梨 来源：一聚教程网
简介
大多数程序员可能都听说过Java自带的一个工具JavaDoc；使用它可以自动地为你的代码生成HTML文档。C＃和C＃编译器也有类似的功能，不过它生成的是XML，而不是直接生成HTML。不过使用XML会使得文档更加灵活。
注释语法
为了使用C＃提供的XML注释功能，你的注释应该使用特殊的注释语法（///）开头。在///之后，你可以使用预先定义的标签注释你的代码，也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。
预定义的标签 用处
将说明中的文本标记为代码
大多数程序员可能都听说过Java自带的一个工具JavaDoc；使用它可以自动地为你的代码生成HTML文档。C＃和C＃编译器也有类似的功能，不过它生成的是XML，而不是直接生成HTML。不过使用XML会使得文档更加灵活。
注释语法
为了使用C＃提供的XML注释功能，你的注释应该使用特殊的注释语法（///）开头。在///之后，你可以使用预先定义的标签注释你的代码，也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。
预定义的标签 用处
提供了一种将多行指示为代码的方法
指定使用方法或其他库成员的示例
允许你指定可能发生的异常类
允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。
向XML注释文档中插入一个列表
向XML注释文档中插入一个段落
描述一个参数
提供了一种指示一个词为参数的方法
允许你将成员的访问许可加入到文档中
用于添加有关某个类型的信息
描述返回值
指定链接
指定希望在“请参见”一节中出现的文本
类型或类型成员的通用描述
描述属性
例子
下面的例子为我们常见的HelloWorld控制台应用程序添加注释：
相关文章
-
进击的汉字深夜放映室方法
04-28
-
逆水寒手游1.3.2新增独珍装备怎么获取
04-28
-
逆水寒手游鹏友上茶联动活动怎么玩 逆水寒手游鹏友上茶联动活动介绍
04-28
-
逆水寒手游1.3.2新增独珍装备怎么获取 逆水寒手游1.3.2新增独珍装备获取方式
04-28
-
庄园领主发展科技树怎么样
04-28
-
崩坏星穹铁道知更鸟机制分析
04-28