C# XML注释说明

C#XML注释，即我们在某个函数前新起一行，输入///，VS.Net会自动增加XML格式的注释
XML注释分为一级注释（Primary Tags）和二级注释（Secondary Tags），前者可以单独存在，后者必须包含在一级注释内部。
一级注释
1. <remarks>对类型进行描述，功能类似<summary>，据说建议使用<remarks>;
2. <summary>对共有类型的类、方法、属性或字段进行注释；
3. <value>主要用于属性的注释，表示属性的制的含义，可以配合<summary>使用；
4. <param>用于对方法的参数进行说明，格式：<param name="param_name">value</param>；
5. <returns>用于定义方法的返回值，对于一个方法，输入///后，会自动添加<summary>、<param>列表和<returns>；
6. <exception>定义可能抛出的异常，格式：<exception cref="IDNotFoundException">；
7. <example>用于给出如何使用某个方法、属性或者字段的使用方法；
8. <permission>涉及方法的访问许可；
9. <seealso>用于参考某个其它的东东:)，也可以通过cref设置属性；
10. <include>用于指示外部的XML注释；
二级注释
1. <c> or <code>主要用于加入代码段；
2. <para>的作用类似HTML中的<p>标记符，就是分段；
3. <pararef>用于引用某个参数；
4. <see>的作用类似<seealso>，可以指示其它的方法；
5. <list>用于生成一个列表；

C# XML注释说明相关推荐

【Groovy】xml 序列化 ( 使用 MarkupBuilder 生成 xml 数据 | 标签闭包下创建子标签 | 使用 MarkupBuilderHelper 添加 xml 注释 )
文章目录一.标签闭包下创建子标签二.使用 MarkupBuilderHelper 添加 xml 注释三.完整代码示例一.标签闭包下创建子标签在上一篇博客 [Groovy]xml 序列化 ( ...
mybatis mapper.xml --注释带参数的坑
注释了直接在下面写了新的sql,注释的时候一般我都习惯性的选中之后Ctrl+/利用编辑器自带的自动注释功能,这个时候编辑器是分两种情况的:情况一是你之前老的sql没有类似<where>这样 ...
使用.NET中的XML注释(一) -- XML注释标签讲解
使用.NET中的XML注释(一) -- XML注释标签讲解作者:Xt Idt 来源:博客园发布时间:2011-04-02 11:46 阅读:9 次原文链接 [收藏] 一.摘要 . ...
Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具
2019独角兽企业重金招聘Python工程师标准>>> Sandcastle是微软提供的一个根据XML注释和DLL文件生成帮助文件的工具,目前是在CodePlex上的一个开源项目,可 ...
html+注释格式化,使用xml注释来生成格式化的html输出
我试图从我在xml文件中的注释中生成一个格式良好的html文档.目前我有一个xml文件,用于生成xml表格的html列表.为了让我添加有关表格的评论,我手动将注释添加到输出html文件中.使用xml注 ...
C# : 操作Word文件的API - (将C# source中的xml注释转换成word文档)
这篇博客将要讨论的是关于: 如何从C#的source以及注释, 生成一份Word格式的关于各个类,函数以及成员变量的说明文档. 他的大背景如下...... 最近的一个项目使用C#, 分N个模块, 在项 ...
【C#本质论十一】合式类型（二）程序集引用、XML注释、垃圾回收和资源清理
上一节介绍到了如何进行Object方法重写和操作符重载,本篇博客来接着介绍合式类型剩余的内容: 程序集引用及命名空间定义其中一些相对简单的内容就不进行过多的介绍了,例如引用其他程序集,只需要注意三种 ...
在C＃使用XML注释
简介大多数程序员可能都听说过Java自带的一个工具JavaDoc:使用它可以自动地为你的代码生成HTML文档.C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML.不过使用X ...
vbnet如何注释_克里斯出售股票为VBNET Develo提供XML注释和文档生成
vbnet如何注释 Chris Sells shares:XML Comments and Documentation Generation for VB.NET Developers...http: ...

C# XML注释说明

C# XML注释说明相关推荐

最新文章

热门文章