c# 注释规范
2015-09-12 21:47
651 查看
模块(类)注释规范
模块开始必须以以下格式编写模块注释///<summary>
///模块编号:<模块编号,可以引用系统设计中的模块编号>
///作用:<对此类的描述,可以引用系统设计中的描述>
///作者:作者中文名
///编写日期<模块创建日期,格式:YYYY-MM-DD>
///</summary>
如果模块有修改,则每次修改必须添加以下注释
///<summary>
///Log编号:<Log编号,从1开始一次增加>
///修改描述:<对此修改的描述>
///作者:修改者的中文名
//修改日期:<模块修改日期:格式:YYYY-MM-DD>
///</summary>
类属性注视规范
///<summary>
///属性说明
///</summary>
方法注释规范
///<summary>
///说明:<对该方法的说明>
///</summary>
///<param name="<参数名称>"><参数说明></param>
///<returns>
///<对此方法返回值的说明,该说明必须明确说明返回值代表什么含义。>
///</returns>
代码间注视规范
//<单行注释>
/*多行注释1
多行注释2
多行注释3*/
#c#杂项
相关文章推荐
- C#实现多态之一抽象
- C#实现多态之一抽象
- Untiy3D笔记之番外篇——c# 生成真正随机数
- 用线程实现C#中的倒计时
- C#语法中的select
- jacobi迭代法(C#实现)
- C#使用Mutex简单实现程序单实例运行的方法
- C# Webkit GetElementById Click
- C# - Recommendations for Abstract Classes vs. Interfaces
- C#学习笔记-----C#枚举中的位运算权限分配
- C#中复制数组
- C#判断字符串中是否包含一个子字符串是可以直接使用Contains()方法
- C# ListView用法详解 很完整
- 【C#】初识c#
- C#黑白棋制作~
- C#黑白棋制作
- C#实现程序等待延迟执行的方法
- C#实现控制摄像头的类
- C#禁止textbox复制、粘贴、剪切及鼠标右键的方法
- [C#]二维码(QR Code)生成与解析