C编码规范(范本).docVIP

C＃编码规范 Code Specification for C＃ （仅供内部使用 Only for inside of bpnet） 作者： (WilliamYe) 日期：20年月日 C#编码规范－文档修改记录 Code Specification for C#—Revision History 版本号 Version 日期Revision Date 修改理由 Summary/Comment 修改修改页Revision Pages 1.0 2010/02/24 Create williamYe ALL 目录 一、目的 4 二、适用范围 4 三、命名空间 4 四、文件命名规范 5 五、控件命名规范 6 5.1 Win Form内部控件命名规范 7 5.2 Web Form内部控件命名规范 8 5.3 C#数据组件命名规范 9 5.4 C#菜单命名规范 10 六、变/常量命名规范 11 6.1变量范围前缀 11 6.2变量类型前缀 11 七、方法命名规范 12 八、代码注释规范 13 8.1代码注释约定 13 8.2模块头部注释规范 13 8.3方法注释规范 14 8.4代码行注释规范 16 8.5变量注释规范 17 九、其它规范 17 9.1编程风格 17 9.2资源释放 19 9.3错误处理： 20 9.4其他 21 一、目的 使用统一编码规范的主要原因，是使应用程序的结构和编码风格标准化，以便于阅读和理解这段编码。 好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。 回目录 二、适用范围 本规范不适用于数据库开发规范，数据库开发相关规范请参考相关文档； 本规范主要以C#为开发语言的规范，为开发部的原则性规范； 由于本规范是为撰写程序而设计，所以适用于一切有关程序撰写的工作事项。对于具体的每个项目，可能需要对之进行裁剪和补存。 补存的内容确认之后公用的内容要更新到此规范中； 适用人员：所有开发人员及代码品管人员； 适用产品：所有以C#编写的代码。 回目录 三、命名空间 命名空间应使用解决方案的名称，每个项目应设置一个二级命名空间，并以项目名命名。 如下图： SDP为解决方案（Solution）的名称，则SDP为顶级命名空间； SDP.BF为项目名称（Assembly），则SDP.BF项目下的命名空间为：SDP.BF.ClassName 回目录 四、文件命名规范 文件命名原则是更容易区分不同的文件类型，在文件名前增加三字符的前缀，前缀字母一律为小写 例如： 一个窗体文件可以增加frm前缀，frmForm1.cs 所有的前缀列表请参考本小节末尾的表格! 文件主体名必须用名词或动名词，且主体名必须是单词首字大写的方式表示 例如： 销货单的窗体可以命名为frmInvoice.cs，一张销货单批次作废的窗体可以命名为frmCancelInvoice.cs 文件名必须采用在不影响原意表达时尽量采用单词缩写的形式命名，以达到文件名的简洁明了的命名目的 例如： 应收帐款批次转凭证窗体的完整窗体名为frmTransferAccountsReceivable.cs，这时的窗体文件名太长，可以采用简写的方式，应收帐款专业简写为AR，我们可以采取这种公认的或专业的简写名词命名，最后可以命名为frmTransAR 文件名要和类名匹配 例如，对于类HelloWorld, 相应的文件名应为 HelloWorld.cs (或, HelloWorld.vb) 文件类型前缀一览表（/表示暂无前缀） Win Form 扩展名 Extension File Name 描述 Description 前缀 Prefix .cs 窗体文件 frm .cs 类文件 / Web Form 扩展名 Extension File Name 描述 Description 前缀 Prefix .aspx / .ascx Web用户自定义控件 wuc 回目录 五、控件命名规范 C#编码时，为了更直观地遍历整个窗体的控件，通常的作法是给每一种类型的控件的名称前增加统一的前缀。前缀字符采用三个小写字母的形式表示（一般常用的控件三个字母都可以满足，也有一些控件无法更好地用三个字母缩写，详见下面的表格。） 例如： 一个开始处理的按钮可以命名为：btnBeginProc 控件主体名称采用名词或动名词的形式命名 例如： 一个单号的标签：lblDocNo 一个开始处理的按钮：btnBeginProc 控件主体名采用单词首字大写的形式命名 例如： 一个产生应收帐款的按钮可以命