文章目录
今天学习了一下.Net代码编写规范,现在有些命名规范是在写代码的时候自动就能用上的,也不知道是什么命名规范,现在就系统的总结一下
一、按照规范写代码的目的:
1.保证代码一致性
2.便于交流及维护
3.增加代码可读性
二、注释规范
1.自建代码注释
/************************************************
*Author:
*Create Time:
*Description:
*
*Update History:
*
***********************************************/
这个是在机房合作的时候加的自定义注释
2.标准注释
在模块、类、属性、方法前加一行注释,以便调用
3.代码间注释
代码中遇到语句块时必须添加注释(if,for,foreach…)等
三、命名规范
1.命名规范总体规则
名字能够表示事物特性,与业务挂钩
名字一律为英文,不含拼音
名字由两三个单词组成
2.命名实例
四、编码规则
1单语句规则
每行只写一条语句,除非这些语句有密切联系
2模块化规则
某一功能,重复实现一遍以上,应考虑模块化,将它写成函数
3函数复杂度规则
单一功能函数不得超过50行,形参个数不能超过7个、程序嵌套不能超过7层
4编码风格规则
代码未写,文档现行
关系运算必须常量在左,变量在右
局部变量必须初定义、避免不必要的内存操作、内存操作考虑异常处理
5版本管理规则
源码包的版本号由圆点隔开的两个数字组成
第一个发行号,第二个该版修改号
如下: