C#编程规约.doc

校园有线网解决方案合肥智同信息技术有限公司

/NUMPAGES1

合肥智同信息技术有限公司作成者作成日确认者确认日

C#编程规约
C#编程规约智同公司版权所有
合肥智同信息技术有限公司电话：0551-53150525325625传真：[phone]

/NUMPAGES1
目录
TOC\o"1-2"\u第1章 修改履历 PAGEREF_Toc112136247\h1
第2章 基本规则 PAGEREF_Toc112136248\h2
2.1 总体要求 PAGEREF_Toc112136249\h2
2.2 可读性要求 PAGEREF_Toc112136250\h2
2.3 结构化要求 PAGEREF_Toc112136251\h2
2.4 正确性与容错性要求 PAGEREF_Toc112136252\h3
2.5 可重用性要求 PAGEREF_Toc112136253\h3
第3章 文件结构 PAGEREF_Toc112136254\h4
3.1 文件头声明 PAGEREF_Toc112136255\h4
3.2 函数/过程说明 PAGEREF_Toc112136256\h4
第4章 命名规则 PAGEREF_Toc112136257\h5
4.1 变量命名 PAGEREF_Toc112136258\h5
4.2 窗体命名 PAGEREF_Toc112136259\h5
4.3 用户控件的命名 PAGEREF_Toc112136260\h5
4.4 函数命名 PAGEREF_Toc112136261\h5
4.5 控件的命名 PAGEREF_Toc112136262\h6
第5章 注释的规范 PAGEREF_Toc112136263\h7
5.1 需要注释的地方 PAGEREF_Toc112136264\h7
5.2 注释的要求 PAGEREF_Toc112136265\h7

C#编程规约智同公司版权所有

合肥智同信息技术有限公司电话：0551-53150525325625传真：[phone]

/NUMPAGES1
修改履历
编号版本修改说明担当者修改时间1.0初版作成孙曙光2007-7

基本规则
总体要求
程序结构清析，简单易懂，单个函数的程序行数最好不超过100行。
打算干什么，要简单，直接了当，代码精简，避免垃圾程序。
尽量使用标准库函数和公共函数。
不要随意定义全局变量，尽量使用局部变量。
使用括号以避免二义性。
可读性要求
可读性第一，效率第二。
保持注释与代码完全一致。
每个源程序文件，都有文件头说明，说明规格见规范。
每个函数，都有函数头说明，说明规格见规范。
主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。
常量定义（CONST）有相应说明。
处理过程的每个阶段都有相关注释说明。
在典型算法前都有注释。
利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节。
循环、分支层次不要超过五层。
注释可以与语句在同一行，也可以在上行。
空行和空白字符也是一种特殊注释。
一目了然的语句不加注释。
注释的作用范围可以为：定义、引用、条件分支以及一段代码。
注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到1/3。

结构化要求
禁止出现两条等价的支路。
禁止GOTO语句。
函数中RETURN后面禁止执行语句。
用CASE实现多路分支。
避免从循环引出多个出口。
函数只有一个出口。
不使用条件赋值语句。
避免不必要的分支。
不要轻易用条件分支去替换逻辑表达式。
正确性与容错性要求
程序首先是正确，其次是优美
无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。
改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。
所有变量在调用前必须被初始化。
对所有的用户输入，必须进行合法性检查。
不要比较浮点数的相等，如：10.0*0.1==1.0，不可靠
程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。
单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。
可重用性要求
重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。
公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。
公共控件或类应建立使用模板。
文件结构
每个程序通常分为两个文件。一个文件用于保存资源（.resx文件），称为资源文件。另一个文件用于保存程序的实现（.cs文件）。
文件头声明
在每个.cs文件的声明，主要内容有：
版权