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

应当用于方法声明的注释,以描述返回 值。 得以从文本内指定链接。 对可以通过当前编译环境进行调用的成员或字段的引用。 应当用于描述类型或类型成员。 得以描述属性。 上述表格具体说明见 “Microsoft Visual Studio .NET 2003 文档“ 之 “Visual Studio .NET\\Visual Basic 和 Visual C#\\参考\\Visual C# 语言\\C# 程序员参考\\C# 语言功能\\XML 文档\\建议的文档注释标记” 的目录。 例图如下:

4. 在公用类库中的公用方法需要在一般方法的注释后添加作者、日期及修改记录信息,统

一采用XML标签的格式加注,标签如下: 作者

建立日期 修必记录

修改作者 修改日期 修改理由

修改作者 修改日期 修改理由

第 16 页 共 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

修改作者 修改日期 修改理由

最后修改日期

5. 一个代码文件如果是由一人编写,则此代码文件中的方法无需作者信息,非代码文件作

者在此文件中添加方法时必须要添加作者、日期等注释,格式参考8.4。 6. 修改任何方法,必须要添加修改记录的注释,格式参考8.4。

回目录

8.4代码行注释规范

1. 如果处理某一个功能需要很多行代码实现,并且有很多逻辑结构块,类似此种代码应该

在代码开始前添加注释,说明此块代码的处理思路及注意事项等 2. 注释从新行增加,与代码开始处左对齐 3. 双斜线与注释之间以空格分开 例如:

回目录

海南蓝点 第 17 页 共 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

8.5变量注释规范

1. 定义变量时需添加变量注释,用以说明变量的用途 2. class级变量应以三条斜线的形式注释

3. 方法级的变量注释可以放在变量声明语句的后面,与前后行变量声明的注释左对齐,注

释与代码间以Tab隔开。 例如:

回目录

海南蓝点 第 18 页 共 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

九、其它规范

9.1编程风格

1. 为了保持更好的阅读习惯,请不要把多个变量声明写在一行中,即一行只声明一个变量。

例如:

String strTest1,strTest2;

应写成:

String strTest1; String strTest2;

2 3

避免方法中有超过5个参数的情况。如果超过了,则应使用 struct 来传递多个参数。

4

为了更容易阅读,代码行请不要太长,最好的宽度是屏幕宽度(根据不同的显示分辩率其可见宽度也不同)。请不要超过您正在使用的屏幕宽度。(每行代码不要超过80个字符。)

除非在不完全的switch语句中否则不要使用goto语句。

注:原则上不应使用goto语句,除非在能够大大减轻编码的复杂性,并不影响可读性的前提下才允许使用。

5 6

在switch语句中总是要有default子句来显示信息 代码缩进

1. 一致的代码缩进风格,有利于代码的结构层次的表达,使代码更容易阅读和传阅 2. 代码缩进请使用“TAB”键实现,讲不要使用空格,为保证在不同的机器上使代码缩进保持一致,特此规定C#的TAB键宽度为4个字符,设定界面如下(C# Tools?Option):

海南蓝点 第 19 页 共 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

7

界面排版

8 方法参数多于8个时采用结构体或类方式传递 9 操作符/运算符左右空一个半角空格

10 所有块的{}号分别放置一行,并嵌套对齐,不要放在同一行上

海南蓝点

第 20 页 共 23 页

Print Date:2020-03-03

联系客服:779662525#qq.com(#替换为@) 苏ICP备20003344号-4