C#项目代码开发规范

《C#项目代码开发规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、C#代码开发规范文件状态：[√]草稿[]正式[]修改文件标识：当前版本：1.0作者：陈蜀联系电话：最后更新：2016-04-0817版本记录日期版本号作者说明2016-4-281.0陈蜀创建17目录1.前言41.1编写目的41.2适用范围41.3基本要求42.命名规范52.1字母大小写约定52.1.1说明52.1.2Pascal风格52.1.3Camel风格52.2标识符的大小写规则52.3通用命名约定52.3.1选择名称52.3.2字母缩写词62.4命名空间命名62.5类、结构和接口命名72.6逻辑层类命名72.7文件夹命名73.注释规范73.1模块（类）注释规

2、范73.2类属性注释规范83.3方法注释规范83.4代码间注释规范84.编码规范95.UI控件命名125.1Windows控件125.2Web控件136.数据库设计146.1原则146.2数据库命名14176.3表命名146.4存储过程146.5视图146.6自定义函数146.7索引146.8触发器157.本地资源文件157.1资源文件的命名157.2Web文件资源设定157.3设置每个文件的资源类型15171.前言1.1编写目的为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。编码规范对于程序员而言尤为重要，有以下几个原因：1)一个软

3、件的生命周期中，80%的花费在于维护。2)几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。3)编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码。每个软件开发人员都必须遵守统一的编码规范。1.2适用范围本规范适用于原型SimpleERP项目的开发。1.3基本要求尽量使代码简单直白。2.命名规范2.1字母大小写约定2.1.1说明表达清晰的命名规范是程序规划的核心，如果规范的命名能清晰的表达出相应的功能，就可以让人“望文知意”，提高开发效率和系统的可维护性。反之，如果命名不能表达其含义，例如“aaa”、“bbb()”，那么将适得其反

4、。2.1.2Pascal风格包含一到多个单词，每一个单词第一个字母大写，其余字母均小写。例如：HelloWorld、SetName等。172.1.1Camel风格包含一到多个单词，第一个单词首字母小写，其余单词首字母大写。例如：name、productId等。2.2标识符的大小写规则1)除了参数与变量外，所有命名空间名称、类、函数、接口、属性等名称的命名，使用Pascal风格。2)参数与变量的命名，使用Camel风格。2.3通用命名约定约定的是如何选择最适当的名称，这些准则适用于所有标识符命名。2.3.1选择名称1)请选择易读的英文名称例如，英文Order的意思为

5、规则、次序、订购等，如果用在排序列中就不是很合适，用来表示订单则更具可读性。可读性比详细描述更重要，比如表示坐标名称ScreenX就比ScreenHorizontally更具可读性。2)除下划线外，不要使用连字符或任何其他非字母数字字符在数据库表字段名称设计时，与其他表字段有关联时，适当的使用表名+下横线+字段名，可以更清晰的表现出该字段与关联表对应字段的关系。比如产品分类表ProductClass有字段Id与Name，那么产品表绑定这两个字段的名称可命名为ProductClass_Id与ProductClass_Name，这样在查看产品表时就可以清晰的知道这两个

6、字段与分类表的关系。3)避免使用与常用编程语言的关键字冲突的标识符4)变量和方法参数使用Camel风格例如：stringproductName="";intnumber=0;stringsqlString="";doubleaverageScore=0.0;Usersusers=newUsers();Usersmodel=newUsers();UsersuserModel=newUsers();conststringconst_String="";（不同公司有不同的约定，具体根据自己公司情况设置而定）17PrivatestringGetProductName(in

7、tid){return"";}1)不要使用成员属性作为成员变量的前缀（其他变量命名也一样）例如：不要像Usersm_users;这样定义成员变量，可以使用第4点的设置。2.1.1字母缩写词1)通常，不应使用缩写2)除非这种缩写已广泛接受，又或者团队当中大家都认可一种缩写例如，使用OnButtonClick，如果团队中普遍认可OnBtnClick这种写法也是可以的。2.2命名空间命名命名空间命名采用Pascal风格，取名的一般规则如下。CompanyName.ProjectName（公司名称.项目名称）例如：Microsoft.Office需要用复数时，请使用复数。

8、例如，使用