代码开发规范.doc

代码开发规范 文件状态： [√] 草稿 [ ] 正式 [ ] 修改 文件标识： 当前版本： 1.1 作 者： Empty 联系电话： 最后更新： 2014-04-07 版本记录 日期 版本号 作者 说明 2014-4-2 1.0 Empty 创建 2014-4-7 1.1 Empty 添加前言、注释规范与编码规范 目 录 1. 前言 4 1.1 编写目的 4 1.2 适用范围 4 1.3 基本要求 4 2. 命名规范 4 2.1 字母大小写约定 4 2.1.1 说明 4 2.1.2 Pascal风格 4 2.1.3 Camel风格 5 2.2 标识符的大小写规则 5 2.3 通用命名约定 5 2.3.1 选择名称 5 2.3.2 字母缩写词 6 2.4 命名空间命名 6 2.5 类、结构和接口命名 6 2.6 逻辑层类命名 6 2.7 文件夹命名 7 3. 注释规范 7 3.1 模块（类）注释规范 7 3.2 类属性注释规范 7 3.3 方法注释规范 7 3.4 代码间注释规范 8 4. 编码规范 9 前言 编写目的 为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 编码规范对于程序员而言尤为重要，有以下几个原因： 1) 一个软件的生命周期中，80%的花费在于维护。 2) 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。 3) 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 。 每个软件开发人员都必须遵守统一的编码规范。 适用范围 本规范适用于《从零开始编写自己的C# 框架》的开发。 基本要求 尽量使代码简单直白roductId等。 标识符的大小写规则 所有命名空间名称、，使用 Pascal 。 ; int number=0; string sqlString=; double averageScore=0.0; Users users=new Users(); Users model=new Users(); Users userModel=new Users(); const string const_String = ;（不同公司有不同的约定，具体根据自己公司情况设置而定） Private string GetProductName(int id) { return ; } 不要使用成员属性作为成员变量的前缀（其他变量命名也一样） 例如： 不要像Users m_users;这样定义成员变量，可以使用第4点的设置。 字母缩写词 通常，不应使用缩写 除非这种缩写已广泛接受，又或者团队当中大家都认可一种缩写 例如，使用 OnButtonClick，如果团队中普遍认可OnBtnClick这种写法也是可以的。 命名空间命名 命名空间命名采用Pascal风格，取名的一般规则如下。 CompanyName. ProjectName （公司名称.项目名称） 例如： Microsoft.Office 需要用复数时，请使用复数。 例如，使用System.Collections而不是System.Collection。 需要缩写时，不需要加复数。 例如：使用System.IO而不是System.IOs。 类、结构和接口命名 按照 Pascal 大小写格式，使用名词或名词短语为类、接口和值类型命名 接口命名以字母 I 为前缀 例如：IComponent 派生类的末尾使用基类名称 例如，从 Stream 继承的 Framework 类型以 Stream 结尾，从 Exception 继承的类型以 Exception 结尾。 逻辑层类命名 按照 Pascal 大小写格式，使用名词或名词短语命名，并加上后缀Logic 文件夹命名 文件夹以功能模块名称，按照 Pascal 大小写格式命名。 比如后端管理功能以及权限相关功能，全部放到Systems文件夹里。 注释规范 模块（类）注释规范 模块开始必须以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD ////summary 类属性注释规范 在类的属性必须以以下格式编写属性注释： //