.Net代码编写规范总结

注释规范

1.自己创建的代码问价在文件前写注释(可以使用自动生成注释)注释的形式一般包括

/*************************************************
作者:
小组:
说明:
创建日期:
版本号:
**********************************************/

2.如果模块值进行部分少量代码的修改,每次添加需要添加注释

///修改人:
///修改日期:<YYYY-MM-DD>
///备份:
/*原代码内容*

3.对于重构类的文件需要对原来的类文件做备份,然后放在统计目录下并且添加后缀
4.代码的注释又分为多行注释和单行注释

单行注释:
//<单行注释>
多行注释:
/*多行注释1
多行注释2
多行注释3*/
命名规范
Pascal命名法:所有单词的首字母都大写,其他字母小写

Camel命名法:除首字母外,其他单词的首字母大写,其他字母小写
(1)在类属性的名称中包含类名是多余的,如Book.BookTitle。而是应该使用Book.Title。
(2)在变量名中使用互补对,如min/max、begin/end和open/close。
(3)布尔变量名应该包含Is,这意味着Yes/No或True/False值,如fileIsFound。
(4)即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如i或j。
(5)文件名要和类名相同,一般情况下一个类一个文件,文件名遵从Pascal命名法,无特殊情况,扩展名小写,使用统一而又通用的文件扩展名:C#类.cs。
(6)不要将缩写或缩略形式用作标识符名称的组成部分。
(7)类名使用Pascal大小写,使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML。
(8)接口使用Pascal大小写。在原有类名基础上加“I”,如:IUserDao
(9)参数参数名称使用Camel大小写
(10)方法使用Pascal大小写。,禁止缩写

版本管理规则
每个任务在完成一个稳定的版本后,都应打包并且归档。源码包的版本号由 圆点隔开的两个数字组成,第一个数字表示发行号,第二个数字表示该版的修改 当源码包初版时,版本号为V1.00; 当源码包被局部修改或bug修正时,发行号不变,修改号第二个数字增。例如,对 V1.01
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 12
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 12
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值