一、基本代码格式
1.所有代码使用四个空格表示缩进,配置Visual Studio 文字编辑器,以空格代替制表符 。
2.花括号一定独占一行。
3.引入的命名空间应该按照字母音序排列,这样做的目的在于方便在引入的多个命名空间中直接快速的找到命名空间。
二、 文件定义
通常情况下,一个cs文件只能定义一个类、接口、枚举、结构体,特殊情况可将多个类定义在同一cs文件,如代码生成器生成的代码或紧密关联的两个class。
其次类名应该与cs文件名保持一致,以便于通过文件名查找类名,比如UserInfo类应该在UserInfo.cs文件里。
语句 一定不要在同一行内放置一句以上的代码语句。 这会使得调试器的单步调试变得更为困难。
三、命名方法
1.使名称足够长以便有一定的意义,并且足够短以避免冗长。以助人们阅读。
2.使用Pascal命名法:将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 命名法。例:BackColor。
四、函数规范
1.一个函数只完成一个功能。
2.函数长度尽量少于50行,以便维护。
3.避免函数的代码嵌套过深,新增函数的代码嵌套不超过4层.
五、注释规范
1.源文件头部应进行注释,列出:日期、作者、目的、功能等,注释应同步更新,不能有二义性;
2.注释风格:使用 // 或 /* */。
3.数据成员注释:注释说明用途,如果变量类型与变量名已经足以描述一个变量,那么就不再需要加上注释
4.分支语句(条件分支、循环分支)需编写注释;
5.注释不宜过多,但也不能太少,控制在20%~30%。