公司代码规范(c#)

《公司代码规范(c#)》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、××信息技术有限责任公司代码编写规范（初稿）作者：×××目录0、修订记录41、概述41.1、规范制定原则42、基本规则42.1命名法Pascal、Camel42.2Namespace命名空间规范53、文件命名64、C#语法规范64.1符号规范64.1.1换行64.1.2缩进74.1.3空行84.1.4空格94.1.5花括号{}94.2代码注释104.2.1类注释104.2.2代码注释104.3命名规范114.3.1名称清晰114.3.2缩写词124.4控件命名125、SQL语法规范135.1数据表命名规范135.2数据库对象命名规范135.3常用数据表前

2、缀建议145.4数据表字段定义145.5代码书写规范155.3.1、SELECT语句：155.3.2、INSERT语句：155.3.3、UPDATE语句：155.3.4、DELETE语句：155.3.5、IF语句：165.3.6、CASE语句：165.3.7、WHILE语句：16附录：.Net命名规范171、变量命名规范172、Web控件命名规范173、ADO.NET控件命名规范184、Html控件命名规范185、客户端JavaScript规范196、命名规则补充197、命名通则20零、修订记录版本作者日期说明一、概述1.1、规范制定原则1、方便代码的交

3、流和维护。2、不影响编码的效率，不与大众习惯冲突。3、使代码更美观、阅读更方便。4、使代码的逻辑更清晰、更易于理解。二、基本规则2.1命名法Pascal、CamelPascal命名法：指首字母大写，每个连接单词的首字母也大写，应用在文件、类、对象、方法及属性的命名，例如：//文件命名UserInfo.aspx//类命名publicclassUserInfo(){//方法、行为命名publicstringBuyApple{...}//属性命名publicstringName{get{return_name;}}}Camel命名法：指首字母小写，每个连接单词

4、的首字母大写，应用在变量申明中，例如：//申明对象UserInfouserInfo=newUserInfo();//申明变量intrecordCount=0;stringuserName="";备注：其他未规范的命名方法，请遵循微软C#.Net官方命名法。2.2Namespace命名空间规范原则上命名空间层次不要超过3层最为易于理解，例如：Zsp.ICS.Common.StringManager.Encryption在使用上就非常费劲。系统提供功能举例：Zsp.DbHelperZsp：正卓公司服务框架前缀DbHelepr：框架级功能名称项目应用举例：IC

5、S.CommonAMS.StringProcessor.EncryptionICS、AMS：项目名称前缀，这里表示《内控系统》项目Common、StringProcessor：项目内命名空间名称三、文件命名严禁使用拼音命名：publicZhiFu(){}采用Pascal命名法，单词连贯不间断，每个单词首字母大写。正确的方式：PrintPageInfo.aspxBudgetInfoManager.aspx错误的方式：Print_Page_Info.aspxBUDGETInfoManager.aspxbudgetinfomanager.aspx四、C#语法规

6、范4.1符号规范4.1.1换行换行主要目的是为了让过长的代码可读性增强。1、分号“;”之后必须换行，正确的方式：inti=0;stringname;错误的方式：inti=0;stringname;2、逗号“,”时可以换行，如果字符较短可以不换行，正确的方式：stringsql=string.Format("SELECT*FROMTableNameWHEREID={0}ANDSex={1}",dataID.ToString(),0);错误的方式：stringsql=string.Format("SELECT*FROMTableNameWHEREID={0}

7、ANDSex={1}",dataID.ToString(),0);4.1.2缩进代码统一使用Tab缩进，显示格数为4，不要使用空格缩进代码，正确的例子：if(true)return;错误的例子：if(true)return;VS可在：“工具>选项>文本编辑器>所有语言>制表符”中找到设置选项，请设置为下图所示：4.1.3空行在类、接口、枚举的定义代码之间需要空一行，便于区不同区段。在代码中适量使用空行，也可以有效增加代码可读性。例如：publicclassUserInfo{decimal_money;publicdecimalMoney{set{_mon

8、ey=value;}}publicboolBuy(Appleapple){if(