易企网站建设,网站添加后台,四个字广告公司名字,网站建设 成本分析目录XML文档编译器识别的标记添加XLM注释的方法添加XLM注释的例子XML文档
C#可以根据特定的注释自动创建XML格式的文档说明。 这些注释都是单行注释#xff0c;但都以三条斜杠开头
编译器识别的标记
标记说明C把行中的文本标记为代码#xff0c;例如cint …
目录XML文档编译器识别的标记添加XLM注释的方法添加XLM注释的例子XML文档
C#可以根据特定的注释自动创建XML格式的文档说明。 这些注释都是单行注释但都以三条斜杠开头
编译器识别的标记
标记说明C把行中的文本标记为代码例如cint i10;/ccode把多行标记为代码example标记为代码示例exception说明一个异常类include包含其他文档说明文件的注释list把列表插入文档中para建立文本的结构param标记方法的参数paramref表明一个单词是方法的参数permission说明对成员的访问remarks给成员添加描述returns说明方法的返回值see提供对另一参数的交叉引用seealso提供描述中的参见部分summary提供类型或成员的简短描述typeparam用在泛型类型的注释中以说明一个类型参数typepararef类型参数的名称value描述属性
添加XLM注释的方法
在要注释内容的上一行点击三次“/”(要在英文输入的模式下)编译器会自动添加注释内容如果还是添加不上在vs下点击工具-选项-文本编辑器-C#-高级-(勾选)为///生成XLM文档注释
/// summary
/// 这里添加函数说明描述
/// /summary
/// param namea这里添加参数说明描述/param
/// param nameb这里添加参数说明描述/param
/// returns这里添加返回值说明描述/returns添加XLM注释的例子
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;namespace XML文档
{class Program{static void Main(string[] args){int A 1;int B 2;Add(A, B);}/// summary/// 计算两个整数的和/// /summary/// param namea/param/// param nameb/param/// returns返回ab的和/returnsstatic int Add(int a, int b){a a b;return a;}}
}
