C# 注释(Comment)规范
2015-08-10 15:10
543 查看
C# 注释(Comment)规范
1. 模块(类)注释规范
模块开始必须以以下形式书写模块注释:
///<summary>
///模块编号:<模块编号,可以引用系统设计中的模块编号>
///作用:<对此类的描述,可以引用系统设计中的描述>
///作者:作者中文名
///编写日期:<模块创建日期,格式:YYYY-MM-DD>
///</summary>
如果模块有修改,则每次修改必须添加以下注释:
///<summary>
///Log编号:<Log编号,从1开始一次增加>
///修改描述:<对此修改的描述>
///作者:修改者中文名
///修改日期:<模块修改日期,格式:YYYY-MM-DD>
///</summary>
2. 类属性注释规范
在类的属性必须以以下格式编写属性注释:
///<summary>
///属性说明
///</summary>
3. 方法注释规范
在类的方法声明前必须以以下格式编写注释
///<summary>
///说明:<对该方法的说明>
///</summary>
///<paramname="<参数名称>"><参数说明></param>
///<returns>
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///</returns>
1. 模块(类)注释规范
模块开始必须以以下形式书写模块注释:
///<summary>
///模块编号:<模块编号,可以引用系统设计中的模块编号>
///作用:<对此类的描述,可以引用系统设计中的描述>
///作者:作者中文名
///编写日期:<模块创建日期,格式:YYYY-MM-DD>
///</summary>
如果模块有修改,则每次修改必须添加以下注释:
///<summary>
///Log编号:<Log编号,从1开始一次增加>
///修改描述:<对此修改的描述>
///作者:修改者中文名
///修改日期:<模块修改日期,格式:YYYY-MM-DD>
///</summary>
2. 类属性注释规范
在类的属性必须以以下格式编写属性注释:
///<summary>
///属性说明
///</summary>
3. 方法注释规范
在类的方法声明前必须以以下格式编写注释
///<summary>
///说明:<对该方法的说明>
///</summary>
///<paramname="<参数名称>"><参数说明></param>
///<returns>
///<对方法返回值的说明,该说明必须明确说明返回的值代表什么含义>
///</returns>
相关文章推荐
- C#语言 -- 类型转换
- C#实现向已存在的Excel文件中写入数据实例(两种方法)
- C# 最小化窗口截图 句柄 调用截图 黑屏原因
- c# 委托
- 彻底理解C#中值类型和引用类型的区别
- WinForm容器内控件批量效验是否允许为空?设置是否只读?设置是否可用等方法分享
- WinForm容器内控件批量效验是否允许为空?设置是否只读?设置是否可用等方法分享
- C# 合并DLL, 合并DLL进入EXE 【转】
- 快速上手之 C#操作WORD对象模型
- Word模板生成C#源码
- C#基础系列——委托和设计模式(二)
- C#基础之二
- mongdo通用类(C#版)
- C# Access
- Microsoft Dynamics CRM server 2013 中业务规则,有点像C#的正则表达式
- Microsoft Dynamics CRM server 2013 中业务规则,有点像C#的正则表达式
- 使用C#详解常用排序算法(三):归并排序(Merge Sort)
- C# 静态成员
- 使用C# 和Consul进行分布式系统协调
- C#里partial关键字的作用(转摘)