代码开发规范.doc

代码开发规范
文件状态:
[√] 草稿
[ ] 正式
[ ] 修改
文件标识:
当前版本:

作者:
Empty
联系电话:
最后更新:
2014-04-07
版本记录
日期
版本号
作者
说明
2014-4-2

Empty
创建
2014-4-7

Empty
添加前言、注释规范与编码规范
目录
1. 前言 4
编写目的 4
适用范围 4
基本要求 4
2. 命名规范 4
字母大小写约定 4
说明 4
Pascal风格 4
Camel风格 5
标识符的大小写规则 5
通用命名约定 5
选择名称 5
字母缩写词 6
命名空间命名 6
类、结构和接口命名 6
逻辑层类命名 6
文件夹命名 7
3. 注释规范 7
模块(类)注释规范 7
类属性注释规范 7
方法注释规范 7
代码间注释规范 8
4. 编码规范 9
前言
编写目的
为了保证编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。
编码规范对于程序员而言尤为重要,有以下几个原因:
1) 一个软件的生命周期中,80%的花费在于维护。
2) 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。
3) 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。
每个软件开发人员都必须遵守统一的编码规范。
适用范围
本规范适用于《从零开始编写自己的C# 框架》的开发。
基本要求
尽量使代码简单直白。
命名规范
字母大小写约定
说明
表达清晰的命名规范是程序规划的核心,如果规范的命名能清晰的表达出相应的功能,就可以让人“望文知意”,提高开发效率和系统的可维护性。反之,如果命名不能表达其含义,例如“aaa”、“bbb ()”,那么将适得其反。
Pascal风格
包含一到多个单词,每一个单词第一个字母大写,其余字母均小写。例如:HelloWorld、SetName等。
Camel风格
包含一到多个单词,第一个单词首字母小写,其余单词首字母大写。例如:name、productId等。
标识符的大小写规则
除了参数与变量外,所有命名空间名称、类、函数、接口、属性等名称的命名,使用 Pascal 风格。
参数与变量的命名,使用Camel风格。
通用命名约定
约定的是如何选择最适当的名称,这些准则适用于所有标识符命名。
选择名称
请选择易读的英文名称
例如,英文 Order的意思为规则、次序、订购等,如果用在排序列中就不是很合适,用来表示订单则更具可读性。
可读性比详细描述更重要,比如表示坐标名称ScreenX就比ScreenHorizontally 更具可读性。
除下划线外,不要使用连字符或任何其他非字母数字字符
在数据库表字段名称设计时,与其他表字段有关联时,适当的使用表名+下横线+字段名,可以更清晰的表现出该字段与关联表对应字段的关系。
比如产品分类表ProductClass有字段Id与Name,那么产品表绑定这两个字段