软件开发代码规范(C#版).docx

《软件开发代码规范(C#版).docx》由会员分享，可在线阅读，更多相关《软件开发代码规范(C#版).docx（28页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、软件开发代码规范(C#版) 文档编号 版本 密级1.0 本部门开放 工作规范 共 17 页 软件开发代码规范（C#版） 拟制: 日期：2007-2-13 审核: 日期：审核: 日期：批准: 日期：版权全部 * 有限公司修订纪录 日期修订版本描述作者2007-2-13 1.00 初稿完成2007-5-10 1.01 修正2007-11-2 1.02 修正目录 1、 第一章 命名规范 . 4 1.1、 第一节 总则 . 4 1.2、其次节 变量命名规范 . 4 1.2.1、CodeBehind 内部命名规范 . 4 1.2.2、控件命名规范 . 5 1.3、第三节 常量命名规范 . 5 1.4、第

2、四节 命名空间、类、方法命名规范 . 5 1.5、第五节 接口命名规范 . 6 1.6、第六节 命名规范小结 . 6 2、其次章 代码注释规范 . 6 2.1、第一节 模块级注释规范（命名空间、类等）. 6 2.2、其次节 方法级注释规范 . 7 2.2.1 、属性注释 . 7 2.2.2 、方法注释 . 7 2.3、第三节 代码间注释规范 . 8 3、第三章 编写规范 . 9 3.1、第一节 格式规范 . 9 3.2、其次节 编程规范 . 9 3.2.1 、程序结构要求 . 9 3.2.2 、可读性要求 . 10 3.2.3 、结构化要求 . 10 3.2.4 、正确性与容错性要求 . 10

3、 3.2.5 、可重用性要求 . 11 3.2.6 、interface 运用留意事项 . 11 3.2.7 、类运用留意事项 . 11 3.2.8 、流程限制语句留意事项 . 12 3.2.8 、其他应留意事项 . 13注：Pascal 命名法则：即名称中全部单词的第一个字母大写其他字母运用小写形式。 Camel 命名法则：即名称中第一个单词各个字母全部小写, 其他部分遵循 Pascal 命名法则。1 、 第一章 命名规范 1.1 、 第一节 总则 1 本命名规则除特别提及外统一运用 Camel 命名法则。如 如：controlMenu 2 命名时尽量不运用拼音, 更不行运用拼音缩写（专出名

4、词除外）。3 假如运用品牌名称命名时其大小写尽量保持和品牌名称一样的样式。如 如：LuX 则命名时, 不要写成 LUX, 或者 Lux, 而应当保持与原品牌名称风格一样运用 LuX 4 运用专出名词或英文缩写命名时采纳大写形式。如 如：CNNIC 5 禁止运用仅区分大小写的方式命名。如 如：Abc 与 abc 仅用大写 A 来区分, 这样写在类 C 系语言中不会出错, 但是不利于系统的迁移 1.2 、其次节 变量命名规范 1.2.1 、CodeBehind 内部命名规范 1公有字段/属性运用 Pascal 命名规则, 私有变量/爱护变量/局部变量运用 Camel 命名规则, 遵循动宾结构。 例

5、：public class Hello private string userName;private DateTime loginTime;private bool isOnline;public string UserName get return this.userName; 2 即使对于可能仅出现在几个代码行中的生存期很短的变量, 仍旧运用意义描述性的名称。仅对于短循环索引运用单字母变量名, 如 i 或 j3在变量名中运用互补对, 如 Min/Max、Begin/End 和 Open/Close。4当一个方法内部变量繁多的时候, 可以运用 Camel 命名法则, 其中第一个单词可以运用

6、变量类型的缩写来说明以示区分。例：string strName; int intAge; object objPerson; 1.2.2 、控件命名规范1控件命名运用控件缩写加名称的方式 例：控件缩写 声明 LabellblprotectedLabellblName;TextBoxtxtprotectedTextBox txtContent;CheckBoxchkprotectedCheckBox chkRight;ButtonbtnprotectedButton btnOK;ListBoxlbxprotectedListBox lstItem;DropDownListddlprotected

7、DropDownList ddlArea; etc.1.3 、第三节常量命名规范 常量名也应当有肯定的意义, 格式为 NOUN 或 NOUN_VERB。常量名均为大写, 字之间用下划线分隔。例： private const boolWEB_ENABLEPAGECACHE_DEFAULT= true; private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT= 3600; private const boolWEB_ENABLESSL_DEFAULT = false; 注：变量名和常量名最多可以包含 255 个字符, 但是, 超过 25 到

8、30 个字符的名称比较笨拙。此外, 要想取一个有实际意义的名称, 清晰地表达变量或常量的用途, 25 或 30 个字符应当足够了。1.4 、第四节命名空间、类、方法命名规范 1名字应当能够标识事物的特性。2名字尽量不运用缩写, 除非它是众所周知的。3名字可以有两个或三个单词组成, 但通常不应多于三个。4运用名词或名词短语命名类。5尽可能少用缩写。6不要运用下划线字符 (_)。7命名空间名称运用此格式：Snda + 项目名称 + 逻辑层名称 例：namespace Snda.CodeTest.BR public class FileStream public void InPut(string

9、para) 1.5 、第五节接口命名规范 和类命名规范相同, 唯一区分是接口在名字前加上大写I前缀 例： interface IDBCommand; interface IButton; 1.6 、第六节 命名规范小结 1、运用 Pascal 命名方式命名类、方法、属性和常量 2、运用 Camel 命名方式命名局部变量和方法的参数 3、接口运用 Pascal 命名方式, 并且在前面添加I 4、方法命名运用动宾结构, 比如 ShowDialog( ) 5、有返回值的方法命名应有单词来描述, 比如 GetObjectState( ) 6、避开运用带命名空间的类型, 尽量用 using 关键字 7、

10、避开把 using 语句放到命名空间内 8、控件命名运用控件缩写加名称的方式 9、常量命名采纳全部大写的形式, 要想一个有实际意义的名称, 清晰地表达常量的用途 2 、其次章 代码注释规范 2.1 、第一节模块级注释规范（命名空间、类等）模块须以以下形式书写模块注释：/ <summary>/ （功能模块简述）/ </summary> / <remarks> / 名称：（或者编号, 当模块繁多的时候以编号检索）/功能：/ 程序设计：/ 开发日期：/ 备注：/ 修 改 人：/ 修改日期：/ 备注：（假如多次修改, 请重复以上三项）/ </remarks&g

11、t; public class TestSpace 留意：具体说明都写在<remarks></remarks>内部, 为的是既便利 IDE 动态帮助又便利自动化出工程文档, 适用以下注释规范, 不再赘述。修改人和修改日期每次修改的时候都要自行添加上去。2.2 、其次节方法级注释 规范 2.2.1 、属性注释属性必需以以下形式赐予注释, 假如有备注的需求请加在<remarks></remarks>内部：/ <summary> / 简述属性功能 / </summary> / <remarks> / 备注 / <

12、;/remarks> public string Name; 2.2.2 、方法注释 / <summary> / （简述方法功能）/ </summary> / <param name=<参数名称>><参数说明></param> / <returns> / 对方法返回值的说明, 该说明必需明确说明返回的值代表什么含义 / </returns>/ <example>(运用示例)</example> / <remarks> / 名称：（或者编号, 当模块繁多的时候

13、以编号检索）/功能：/ 程序设计：/ 开发日期：/ 备注：/ 修 改 人：/ 修改日期：/ 备注：（假如多次修改, 请重复以上三项）/ </remarks>public void TestMethod(string Para) 2.3 、第三节代码间注释规范 代码间注释分为单行注释和多行注释： 单行注释：/<单行注释> 多行注释：/*多行注释 1 多行注释 2 多行注释 3*/ 代码中遇到语句块时必需添加注释（if,for,foreach,„„）,添加的注释必需能够说明此语句块的作用和实现手段（所用算法等等）。但是自不待言的代码不易注释。行间的注

14、释量不得大于代码量的, 不小于 2.4 、第四节功能变更 注释规范 当对某个现有的功能进行修改时, 须要在该功能所在的方法<summary></ summary >内部加上注释, 阐明变更内容、变更时间、变更人。假如这一功能变更特别重要, 请在模块描述中也加上相关注释。建议格式如下：/功能变更：XXXXX updated by who YYMMDD3 、第三章编写规范 3.1 、第一节 格式规范 1 全部的缩进为 1 个 Tab（设置 1 个 Tab 占 4 个空格空间）, 运用 VS.NET 的默认设置。2 在代码中垂直对齐左括号和右括号。例：if (x = 0) t

15、his.Response.Write(用户编号必需输入！); 允许以下状况：if (x = 0) this.Response.Write(用户编号必需输入！); 不允许以下状况：if (x = 0) this.Response.Write(用户编号必需输入！); 3 为了防止在阅读代码时不得不滚动源代码编辑器, 每行代码或注释在 1024*800 的显示频率下不得超过一显示屏。4 当一行被分为几行时, 通过将串联运算符放在每一行的末尾而不是开头, 清晰地表示没有后面的行是不完整的。5 每一行上放置的语句避开超过一条。6 在大多数运算符之前和之后运用空格, 这样做时不会变更代码的意图却可以使代码

16、简单阅读。例：int j = i + k; 而不应写为int j=i+k; 7 将大的困难代码节分为较小的、易于理解的模块。3.2 、其次节 编程规范 3.2.1 、程序结构要求 1 程序结构清楚, 简洁易懂, 单个函数的程序行数不得超过 100 行。2 准备干什么, 要简洁, 直截了当, 代码精简, 避开垃圾程序。3 尽量运用.NET 库函数和公共函数(无特别状况不要运用外部方法调用 Windows 的核心动态链接库 API)。4 不要随意定义全局变量, 尽量运用局部变量。3.2.2 、可读性要求 1 保持注释与代码完全一样。2 去除无效的注释 3 处理过程的每个阶段都有相关注释说明。4 利

17、用缩进来显示程序的逻辑结构, 缩进量一样并以 Tab 键为单位, 定义 Tab 为 4 个空格。5 循环、分支层次不要超过五层。6 注释可以与语句在同一行, 也可以在上行, 视语句的长短而定。7 一目了然的语句不加注释。8 注释的作用范围可以为：定义、引用、条件分支以及一段代码。9 去除 IDE 自动生成的注释, 比如：. private void Page_Load(object sender, EventArgs e) /to do.（删除这段注释） 3.2.3 、结构化要求 1 禁止出现两条等价的支路。2 除了在 switch 关键字的作用域内, 禁止 goto 语句。3 用 if 语句

18、来强调只执行两组语句中的一组。禁止 else goto 和 else return。4 用 case 实现多路分支。5 避开从循环引出多个出口。6 函数只有一个出口。7 尽量不运用条件赋值语句。8 避开不必要的分支。9 不要轻易用条件分支去替换逻辑表达式。3.2.4 、正确性与容错性要求 1 程序首先是正确, 其次是美丽。2 无法证明你的程序没有错误, 因此在编写完一段程序后, 应先回头检查。3 改一个错误时可能产生新的错误, 因此在修改前首先考虑对其它程序的影响。4 全部变量在调用前必需被初始化。5 对全部的用户输入, 必需进行合法性检查。6 尽量不要比较浮点数的相等,如：10.0 * 0.

19、1 = 1.0 ,不行靠, 因为不同 CPU 的浮点运算实力是不同的 7 程序与环境或状态发生关系时, 必需主动去处理发生的意外事务, 如文件能否逻辑锁定、打印机是否联机等,对于明确的错误,要有明确的容错代码提示用户, 在这样不确定的场合都运用 try throw catch。8 单元测试也是编程的一部份, 提交联调测试的程序必需通过单元测试。9 尽量运用规范的容错语句. 例：try catch finally 3.2.5 、可重用性要求 1 重复运用的完成相对独立功能的算法或代码应抽象为 服务或类。2 服务或类应考虑 OO 思想, 削减外界联系, 考虑独立性或封装性。3.2.6 、inter

20、face 使 使 用留意事项 1避开一个接口中只有一个成员。尽量使每个接口中包含 35 个成员。接口中的成员不应当超过 20 个。避开接口成员中包含事务。2举荐运用显式的接口实现。3.2.7 、类运用留意事项 1避开方法的返回值是错误代码。2尽量定义自定义异样类。当须要定义自定义的异样时：a)自定义异样要继承于 ApplicationException。b)供应自定义的序列化功能。3只对外公布必要的操作。4使程序集尽量为最小化代码(EXE 客户程序)。运用类库来替换包含的商务逻辑。5不要供应 public 的成员变量, 运用属性代替他们。6避开在继承中运用 new 而运用 override 替

21、换。7在不是 sealed 的类中总是将 public 和 protected 的方法标记成 virtual 的。8避开显式的转换, 运用 as 操作符进行兼容类型的转换。例：Dog dog = new GermanShepherd();GermanShepherd shepherd = dogasGermanShepherd;if (shepherd != null )9当类成员包括托付的时候在调用托付之前肯定要检查它是否为 null 例：public class MySource public event EventHandlerMyEvent; public void FireEvent

22、() EventHandler temp = MyEvent;if(temp != null ) temp(this,EventArgs.Empty); 10不要供应公共的事务成员变量, 运用事务访问器替换这些变量。例：public class MySource MyDelegate m_SomeEvent ; public event MyDelegate SomeEvent add m_SomeEvent += value;remove m_SomeEvent -= value; 11避开在结构里面供应方法。建议运用参数化构造函数, 可以重裁操作符。12类成员间调用请尽量运用 this 关

23、键字。13除非你想重写子类中存在名称冲突的成员或者调用基类的构造函数否则不要运用base 来访问基类的成员。3.2.8 、流程限制语句留意事项 1即使 if 语句只有一句, 也要将 if 语句的内容用大括号扩起来。2避开在条件语句中调用返回 bool 值的函数。可以运用局部变量并检查这些局部变量。例：bool IsEverythingOK()/避开if (IsEverythingOK ()/替换方案 bool ok = IsEverythingOK();if (ok)3总是运用基于零起先的数组。4在循环中总是显式的初始化引用类型的数组。例：public class MyClassMyClass

24、 array = new MyClass100;for(int index = 0; index < array.Length; index+)arrayindex = new MyClass();5除非在不完全的 switch 语句中否则不要运用 goto 语句。3.2.8 、其他应留意事项 1避开将多个类放在一个文件里面。2一个文件应当只有一个命名空间, 避开将多个命名空间放在同一个文件里面。3一个文件最好不要超过 500 行的代码（不包括机器产生的代码）。4避开方法中有超过 5 个参数的状况。运用结构来传递多个参数。5每行代码不要超过 80 个字符。6不要手工的修改机器产生的代码。

25、假如须要编辑机器产生的代码, 编辑格式和风格要符合该编码标准。7不要硬编码数字的值, 总是运用构造函数设定其值或采纳常数的方式。8只有是自然结构才能干脆运用 const, 比如一个星期的天数。9避开在只读的变量上运用 const。假如想实现只读, 可以干脆运用 readonly。例：public class MyClass public readonly int Number; public MyClass(int someValue) Number = someValue; public const intDAYS_IN_WEEK = 7; 10代码的每一行都应当通过白盒方式的测试。11在捕

26、获(catch)语句的抛出异样子句中(throw), 总是抛出原始异样维护原始错误的堆栈安排。例：catch(Exception exception)MessageBox.Show(exception.Message); throw;/和 throw exception 一样。12避开在单个程序集里运用多个 Main 方法。13数据访问中凡是运用 DateReader 对象的, 必需运用 using 语句来即时释放资源； 对于 Stream、StreamReader 之类的对象, 也要运用 using 语句来即时释放资源 14避开指定特别类型的枚举变量。例：/避开 public enum Co

27、lor: longRed,Green,Blue15不要硬编码可能更改的基于配置的字符串, 比如连接字符串。16当须要构建长的字符串的时候, 运用 StringBuilder 不要运用 string 17能运用早期绑定就不要运用后期绑定。18运用应用程序的日志和跟踪。19总是选择运用 C#内置（一般的 generics）的数据结构。比如：运用 int 而不用 Int32,运用 object 而不用 Object, 运用 string 而不用 String 等。20将全部的系统命名空间组织在一起, 将全部自定义的命名空间组织在一起例：using System;using System.Data;u

28、sing System.Collections;using MyNameSpace;using MyControls; 21数据访问方法编写完成之后, 必需进行单元测试, 保证调用无异样。22运用一个对象（或对象的属性）前, 必需保证该对象非空(作 null 推断)。23运用一个数组中的某个元素时, 必需保证不会超出索引界限。24A 开发中, 对于 Repeater、DataList、GridView 一类的服务器控件。应本着节约服务器资源的原则, 能用 DataList 完成的就不用 GridView, 能用 Repeater 完成的就不用 DataList。25A 开发中, 对于页面上服务

29、器端控件产生的 ViewState, 没实际用处的就干脆禁用；对于首页、频道页等会被缓存的页面, 要慎重运用服务器端控件, 不允许产生任何 ViewState, 并且不要运用 postback 提交 26A 开发中, 对于页面上服务器端控件产生的 ViewState, 没实际用处的就干脆禁用；对于首页、频道页等会被缓存的页面, 要慎重运用服务器端控件, 不要运用postback 提交, 不允许产生任何 ViewState 27对于数据访问层、业务层和页面层抛出的异样, 要区分出 Exception 和 Error, 对这两种状况进行区分处理。Exception 一般指数据库的、非控的严峻错误,

30、 务必要记录下异样类型以及堆栈信息, 以便将来排查问题；对于 Error 通常都是指业务错误, 此时须要记录下发生错误的相关参数和 errorcode 以便重现问题即可。28 WEB 页面开发完成后, 要作阅读器兼容性测试（IE6、FF 最新版、google 阅读器）28 下班前要确保工程里的全部文件处于签入状态（对于已经开发完成并测试通过的功能可以干脆签入；对于尚未开发完成或者尚未经 QA 确认的功能则先注释掉相关修改, 再行签入）以下内 容为：制定规范的目的和意义 (一) 标准化为科学管理奠定了基础。所谓科学管理, 就是依据生产技术的发展规律和客观经济规律对企业进行管理, 而各种科学管理制

31、度的形式, 都以标准化为基础。(二) 促进经济全面发展, 提高经济效益。标准化应用于科学探讨, 可以避开在探讨上的重复劳动;应用于产品设计, 可以缩短设计周期;应用于生产, 可使生产在科学的和有秩序的基础上进行;应用于管理, 可促进统一、协调、高效率等。(三)标准化是科研、生产、运用三者之间的桥梁。一项科研成果, 一旦纳入相应标准, 就能快速得到推广和应用。因此, 标准化可使新技术和新科研成果得到推广应用, 从而促进技术进步;(四)标准化为组织现代化生产创建了前提条件。随着科学技 术的发展, 生产的社会化程度越来越高, 生产规模越来越大, 技术要求越来越困难, 分工越来越细, 生产协作越来越广

32、泛, 这就必需通过制定和运用标准, 来保证各生产部门的活动, 在技术上保持高度的统一和协调, 以使生产正常进行;所以, 我们说标准化为组织现代化生产创建了前提条件。(五)促进对自然资源的合理利用, 保持生态平衡, 维护人类社会当前和长远的利益。标准化是经过多次实践后得出的最为有效的形式, 对于资源的利用率也是比较高的, 所以标准化在资源的合理化利用方面是有着主动意义的。(六)合理发展产品品种, 提高企业应变实力, 以更好的满意社会需求。标准化是对当前产品的精炼, 是针对市场需求的的细分, 把最适合的保留下来, 这样将更好的满意社会的需求。(七)保证产品质量, 维护消费者利益。标准化的规定的程序

33、进行, 将人为因素对产品质量的影响降到最低, 确保了产品质量。(八) 在社会生产组成部分之间进行协调, 确立共同遵循的准则, 建立稳定的秩序。标准化的采纳, 提高了企业产品之间的兼容性, 削减了由于企业产品之间标准不一样, 带来的巨大社会奢侈。另外, 企业通过标准化可以避开对某一个供货商的依靠, 因为其他供货商依据公开的标准可以补充市场, 于是企业的供货渠道不断增加。供应商数量的增加, 加大了供货商之间的竞争, 从而促使产品质量不断提高, 价格也会不断降低, 建维护了市场稳定的秩序(九)在消退贸易障碍, 促进国际技术沟通和贸易发展, 提高产品在国际市场上的竞争实力方面具有重大作用。加入 WTO

34、 以来, 面对技术壁垒, 我国在大力提高产品质量的同时, 必需依靠标准化工作提高技术水平, 提升保障产品质量, 才能在国际贸易方面有肯定的话语权, 稳定促进国际贸易发展。(十) 保障身体健康和生命平安, 大量的环保标准、卫生标准和平安标准制定发布后, 用法律形式强制执行, 对保障人民的身体健康和生命财产平安具有重大作用。(十一)标准化标记着一个行业新的标准的产生。标准化是产品质量和技术发展肯定水平才能实现的, 标准化实现将进一步促使生产技术的提高, 进行形成更高水平的标准。总之, 标准及标准化所具有的引导性、前瞻性、公允性、强制性和惩戒性, 确定了标准化在市场经济中的作用是多层次的、全方位的, 进而也确定了它是建立和完善市场经济体制不行缺少的重要元素。应用标准化的目的就是为了能有效解决市场经济发展中的质量问题、效率问题、秩序问题、可持续发展问题等。因此, 我们必需从战略的高度重视标准化工作。只有我们不断地去提升标准化水平, 才能有效提升产品质量, 增加产品的市场竞争力, 进一步扩大出口贸易, 从而有效推动经济社会又好又快向前发展。