公司代码规范(C#).doc

××信息技术有限责任公司 代码编写规范（初稿） 作者：××× 目 录 0、修订记录 4 1、概述 4 1.1、规范制定原则 4 2、基本规则 4 2.1命名法Pascal、Camel 4 2.2 Namespace命名空间规范 5 3、文件命名 6 4、C# 语法规范 6 4.1符号规范 6 4.1.1换行 6 4.1.2缩进 7 4.1.3空行 8 4.1.4空格 9 4.1.5花括号{} 9 4.2代码注释 10 4.2.1类注释 10 4.2.2代码注释 10 4.3命名规范 11 4.3.1名称清晰 11 4.3.2缩写词 12 4.4控件命名 12 5、 SQL 语法规范 13 5.1数据表命名规范 13 5.2数据库对象命名规范 13 5.3常用数据表前缀建议 14 5.4数据表字段定义 14 5.5代码书写规范 15 5.3.1、SELECT语句： 15 5.3.2、INSERT语句： 15 5.3.3、UPDATE语句： 15 5.3.4、DELETE语句： 15 5.3.5、IF语句： 16 5.3.6、CASE语句： 16 5.3.7、WHILE语句： 16 附录：.Net命名规范 17 1、变量命名规范 17 2、Web控件命名规范 17 3、ADO.NET控件命名规范 18 4、Html控件命名规范 18 5、客户端JavaScript规范 19 6、命名规则补充 19 7、命名通则 20  零、修订记录 版本 作者 日期 说明 一、概述 1.1、规范制定原则 方便代码的交流和维护。 不影响编码的效率，不与大众习惯冲突。 使代码更美观、阅读更方便。 使代码的逻辑更清晰、更易于理解。 二、基本规则 2.1命名法Pascal、Camel Pascal命名法：指首字母大写，每个连接单词的首字母也大写，应用在文件、类、对象、方法及属性的命名，例如： //文件命名 UserInfo.aspx //类命名 public class UserInfo() { //方法、行为命名 public string BuyApple { ... } //属性命名 public string Name { get { return _name; } } } Camel命名法：指首字母小写，每个连接单词的首字母大写，应用在变量申明中，例如： //申明对象 UserInfo userInfo = new UserInfo(); //申明变量 int recordCount = 0; string userName = ; 备注：其他未规范的命名方法，请遵循微软C#.Net官方命名法。 2.2 Namespace命名空间规范 原则上命名空间层次不要超过3层最为易于理解，例如： Zsp.ICS.Common.StringManager.Encryption在使用上就非常费劲。 系统提供功能举例：Zsp.DbHelper Zsp：正卓公司服务框架前缀 DbHelepr：框架级功能名称 项目应用举例：ICS.Common AMS.StringProcessor.Encryption ICS、AMS：项目名称前缀，这里表示《内控系统》项目 Common、StringProcessor：项目内命名空间名称 三、文件命名 严禁使用拼音命名：public ZhiFu() { } 采用Pascal命名法，单词连贯不间断，每个单词首字母大写。 正确的方式： PrintPageInfo.aspx BudgetInfoManager.aspx 错误的方式： Print_Page_Info.aspx BUDGETInfoManager.aspx budgetinfomanager.aspx 四、C# 语法规范 4.1符号规范 4.1.1换行 换行主要目的是为了让过长的代码可读性增强。 分号“;”之后必须换行，正确的方式： int i = 0; string name; 错误的方式： int i = 0; string name; 逗号“,”时可以换行，如果字符较短可以不换行，正确的方式： string sql = string.Format(SELECT * FROM TableName WHERE ID={0} AND Sex={1} , dataID.ToString() , 0 ); 错误的方式： string sql = string.Format(SELECT * FROM TableName WHERE ID={0} AND Sex={1}, dataID.ToString(), 0 ); 4.1.2缩进 代码统一使用Tab缩进，显示格数为4，不要使用空格缩进代码，正确的例子： if (true