.Net软件项目中的命名规范

  最近公司开发一个后台管理系统,为了编码风格的统一和编码质量的管理,整理了这个文档,方便规范开发人员的工作。
数据库和C#部分内容是网上找的,Asp.Net工程命名是自己写的。对以上各部分根据需要做了增删调整,并整理到一起。 一、数据库命名规范
1.1 数据库命名 规则1 使用Pascal规则命名,首字符要大写。 1.2 数据表命名 规则1 使用Pascal规则命名,首字符要大写,这样显得工整,可读性好。 规则2 表名不要加前缀,尽量不要使用下划线,多张表的中间表可使用下划线。 1.3 字段命名 规则1 使用Pascal规则命名,首字符要大写。 规则2 字段名不要加前缀,不要使用下划线。 1.4 存储过程命名 1.4.1 命名规范 [1] 任何的存储过程必须有前缀'proc'. 系统存储过程都有前缀"sp_", 推荐不使用这样的前缀,因为会稍微的减慢。 [2] 表名就是存储过程访问的对象。 [3] 可选字段名就是条件子句。 [4] 最后的行为动词就是存储过程要执行的任务。    假如返回一条记录,后缀是:Select    假如插入数据,后缀是:Insert    假如更新数据,后缀是:Update 假如删除数据,后缀是:Delete    假如有插入和更新,后缀是:Save    假如返回输出参数或0,那么后缀是:Output 1.4.2 命名语法 [proc]_[MainTableName]_[Action] By [FieldName(condition)] 示例: proc_Users_Get (不用By则默认是ID) proc_ Users _GetByName proc_ Users _Delete (默认按用户编号删除) proc_ Users _DeleteByUserName (按用户登录名删除) proc_ Users _DeleteByName (按名称删除) 二、C#语言命名规范
2.1 类 规则1 使用Pascal规则命名类名,首字符要大写。 规则2 使用能够反映类功能的名词或名词短语命名类。 规则3 类文件的名称要能反映类的内容,最好是和类同名。 2.2 类字段 规则1 使用camel规则命名类成员字段,首单词(或单词缩写)小写。 2.3 方法 规则1 方法名使用Pascal规则,首字符要大写。 规则2 方法名应使用动词或动词短语。 2.4 属性 规则1 属性使用Pascal规则,首字符大写。 规则2 属性名称和相应字段名称要关联,可以使用“封装”命令来生成属性。 2.5 参数 规则1 参数采用camel规则命名,首字符小写。 规则2 使用描述性参数名称,参数名称要具有很强的说明性。 2.6 常量 规则1 只读常量使用Pascal命名规则,首字符大写。 规则2 枚举名使用Pascal规则命名,枚举成员本质属于常量,规则同上。 规则3 静态字段或属性采用Pascal规则,首字符大写。 2.7 接口 规则1 接口定义使用Pascal规则,且必须以大写“I”开头。 规则2 接口名称要有意义,中间不要有下划线“_”等字符。 规则3 如果类实现了接口,名称尽量和接口相同,只是省掉“I”字符。 2.8 事件 规则1 委托名称采用Pascal规则,首字符大写。 规则2定义事件的委托要使用EventHandler后缀,且包括sender和e两个参数。 规则3 事件用到的参数类,名称要带EventArgs后缀。 2.9 命名空间 规则1 命名空间名称采用Pascal规则,首字符大写。 规则2 命名空间名称尽量反映其内容所提供的整体功能。 三、C#控件命名规范
规则1 控件命名使用camel规则,首字符小写。 规则2 名称主要由两部分组合:控件名称缩写和功能描述单词或其缩写。 规则3 坚决不要使用默认的控件名+数字进行命名。 四、ASP.Net工程文件的命名
  4.1 文件夹 规则1 存放代码文件的文件夹,使用Pascal命名规则命名,首字母大写。 规则2 存放资源的文件夹可使用小写,如: css、img、js、dll等。   4.2 文件 规则1 类文件、页面文件使用Pascal命名规则,首字母大写。 规则2 png(图片格式)、css、js、config等资源文件可使用小写。
posted @ 2013-05-18 23:05  kinglong1984  阅读(476)  评论(0编辑  收藏  举报