C#编码规范(范本) 下载本文

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

C#编码规范

Code Specification for C#

(仅供内部使用 Only for inside of bpnet)

作者:叶文良 (WilliamYe) 日期:2010年02月24日

C#编码规范-文档修改记录

海南蓝点

第 1 页 共 23 页

Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

Code Specification for C#—Revision History

版本号 Version 日期日期 Revision Date 修改理由 Summary/Comment 修改作者 修改的页数 Revision By Revision Pages 1.0 2010/02/24 Create williamYe ALL

海南蓝点 第 2 页 共 23 页 Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

目录

一、目的........................................................................................................................................... 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方法注释规范 ................................................................................................................. 15 8.4代码行注释规范 ............................................................................................................. 17 8.5变量注释规范 ................................................................................................................. 18 九、其它规范 ................................................................................................................................. 19

9.1编程风格 ......................................................................................................................... 19 9.2资源释放 ......................................................................................................................... 21 9.3错误处理: ..................................................................................................................... 21 9.4其他 ................................................................................................................................. 23

海南蓝点 第 3 页 共 23 页 Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

一、目的

1. 使用统一编码规范的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和

理解这段编码。

2. 好的编码约定可使源代码严谨、可读性强且意义清楚,与其它语言约定相一致,并且尽

可能的直观。

回目录

二、适用范围

1. 本规范不适用于数据库开发规范,数据库开发相关规范请参考相关文档; 2. 本规范主要以C#为开发语言的规范,为开发部的原则性规范; 3. 由于本规范是为撰写程序而设计,所以适用于一切有关程序撰写的工作事项。对于具体

的每个项目,可能需要对之进行裁剪和补存。 补存的内容确认之后公用的内容要更新到此规范中;

4. 适用人员:所有开发人员及代码品管人员; 5. 适用产品:所有以C#编写的代码。

回目录

三、命名空间

命名空间应使用解决方案的名称,每个项目应设置一个二级命名空间,并以项目名命名。 如下图:

SDP为解决方案(Solution)的名称,则SDP为顶级命名空间;

SDP.BF为项目名称(Assembly),则SDP.BF项目下的命名空间为:SDP.BF.ClassName

海南蓝点 第 4 页 共 23 页 Print Date:2020-03-03

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C#编码规范

Code Specification for C#

文档编号 File No. 版本 Version 密级 Secret Level 作者 Author

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

回目录

四、文件命名规范

1. 文件命名原则是更容易区分不同的文件类型,在文件名前增加三字符的前缀,前缀字母

一律为小写 例如:

一个窗体文件可以增加frm前缀,frmForm1.cs 所有的前缀列表请参考本小节末尾的表格!

2. 文件主体名必须用名词或动名词,且主体名必须是单词首字大写的方式表示

例如:

销货单的窗体可以命名为frmInvoice.cs,一张销货单批次作废的窗体可以命名为frmCancelInvoice.cs

3. 文件名必须采用在不影响原意表达时尽量采用单词缩写的形式命名,以达到文件名的简

洁明了的命名目的

海南蓝点

第 5 页 共 23 页

Print Date:2020-03-03