C#编程规范基本要求如下:
1.程序结构要求
- 程序结构清晰,简单易懂,单个函数的程序行数不能超过100行。
- 打算干什么,要简单,直接了当,代码精简,避免垃圾程序。
- 尽量使用.NET库函数和公共函数(无特殊情况不要使用外部方法调用Windows的核心动态链接库)。
- 不要随意定义全局变量,尽量使用局部变量。
2.可读性要求
- 可读性第一,效率第二(代码是给人读的,不要写别人看不懂的代码)。
- 保持注释与代码完全一致。
- 每个源程序文件,都有规范的头文件说明。
- 每个函数都有函数头说明。
- 主要变量(结构、类或兑对象)定义或引用时,注释能反映其含义。
- 处理过程的每个阶段都有相关注释说明。
- 在典型算法前都有注释。
- 利用缩进来显示程序的逻辑结构,缩进量一致并以TAB键位单位,定义TAB为6个字节。
- 循环、分支层次不要超过5层。
- 一目了然的语句不加注释。
- 注释行数应占总行数的1/5到1/3。
3.结构化要求
- 禁止出现两条等价的支路。
- 禁止使用GOTO语句。
- 避免从循环引出多个出口。
- 函数只有一个出口。
- 避免使用条件赋值语句。
- 不要轻易的用条件分支取替代逻辑表达式。
4.正确性与容错性要求
- 程序首先必须正确,其次才是优美。
- 改一个错误可能产生新的错误,所以在你修改之前首先考虑对其他部分的影响。
- 对所有用户的输入,必须进行合法性检查。
5.可重用性要求
- 重复使用的完成相对独立功能的算法或代码应抽象为ASP.NET服务或类。
- ASP.NET服务或类应考虑OO思想,减少与外界联系,考虑独立性和封装性。
文章参考资料:《亮剑.NET》