内容发布更新时间 : 2024/5/18 12:53:31星期一 下面是文章的全部内容请认真阅读。

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C＃编码规范

Code Specification for C＃

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

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

File Send Fax Format Character Help Contents mnuFileSendFax mnuFormatCharacter mnuHelpContents 当使用这种命名约定时，一个特定的菜单组的所有成员一个接一个地列在 .net 的“属性”窗口中。而且，菜单控件的名字清楚地表示出它们所属的菜单项。

回目录

六、变/常量命名规范

6.1变量范围前缀

1. 为了更好地区分变量的有效范围，例如Class级变量，在定义变量名时用小写字母前缀区分。

2. 此约定同样适用于常量的命名。 3. 常量名必须大写。 回目录

6.2变量类型前缀

1. 定义变量时根据不同的变量类型增加特定的变量类型前缀，一般为小写的三个字母表示

2. 变量主体名与控件主体名和窗体主体名的命名方式一致，采用单词首字大写的方式命名

数据类型 Data type CLR类型 CLR Type 前缀 Prefix 例子 Example bool byte sbyte char decimal double 海南蓝点

System.Boolean System.Byte System.SByte System.Char System.Decimal System.Double bln byt sbyt chr dec dbl Print Date:2020-03-03

第 11 页 共 23 页

文档名称 File Name 存放位置 Locate

中文 Local 英文 English

C＃编码规范

Code Specification for C＃

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

bpnet-S-20100224 V 1.0

内部(INSIDE) WilliamYe

float int uint long ulong short ushort string datetime object 枚举 Structure System.Single System.Int32 System.UInt32 System.Int64 System.UInt64 System.Int16 System.UInt16 System.String System.DateTime System.Object flt int uint lng ulng sht usht str dtm obj enu stru 综上所述，变量命名格式为：<特殊类型前导字(都为小写字母)><类型前缀><变量名字> 特殊类型前导字：

前导字 数据型态 a m I E 有效变量定义的例子：

任何型态的数组(不区分为几维的数组) Class级变量前缀 所有接口声明及变量都应以大写I作为前缀 枚举声明增加E前缀 int[] aintCounters = new int[10]; (表示一个方法级的整型计数器数组)

int[] maintCounters = new int[10]; (表示一个class级的整型计数器数组)

回目录

七、方法命名规范

1. 方法名的主体应该使用大小写混合形式，并且应该足够长以描述它的作用。而且，方法名应该以一个动词起首，如 InitNameArray 或 CloseDialog。

2. 对于频繁使用的或长的项，推荐使用标准缩略语以使名称的长度合理化。一般来说，超过 32 个字符的变量名在 VGA 显示器上读起来就困难了。

海南蓝点

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

3. 当使用缩略语时，要确保它们在整个应用程序中的一致性。在一个工程中，如果一会儿使用 Cnt， 一会儿使用 Count，将导致不必要的混淆。

回目录

八、代码注释规范

8.1代码注释约定

1. 所有的方法和函数都应该以描述这段代码的功能的一段简明注释开始（方法是干什么）。

这种描述不应该包括执行过程细节（它是怎么做的），因为这常常是随时间而变的，而且这种描述会导致不必要的注释维护工作，甚至更糟—成为错误的注释。代码本身和必要的嵌入注释将描述实现方法。

2. 当参数的功能不明显且当过程希望参数在一个特定的范围内时，也应描述传递给过程的

参数。被过程改变的函数返回值和全局变量，特别是通过引用参数的那些，也必须在每个过程的起始处描述它们。

回目录

8.2模块头部注释规范

以一个物理文件为单元的都需要，例如﹕C#中包括 cs 檔

用于每个模块开头的说明，主要包括：（粗体字为必需部分，斜体字为可选部分） 1. 文件名称(File Name)： 此文件的名称

2. 功能描述(Description)： 此模块的功能描述与大概流程说明 3. 数据表(Tables)： 所用到的数据表，视图，存储过程的说明，如关系比较

复杂，则应说明哪些是可擦写的，哪些表为只读的。 4. 作者(Author)：

5. 日期(Create Date)： 6. 参考文档(Reference)： 该档所对应的分析文档，设计文檔。 7. 引用(Using)﹕ 开发的系统中引用其它系统的Dll、对象时，要列出其对应的出处，是否与系统有关﹙不清楚的可以不写﹚，以方便制作安装档。

8. 修改记录(Revision History)：若档案的所有者改变，则需要有修改人员的名字、

修改日期及修改理由。

海南蓝点

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

R1: 修改作者: 修改日期： 修改理由: R2: 修改作者: 修改日期： 修改理由: R3: … R10 … R100

9. 分割符：＝＝＝＝＝＝＝＝＝＝＝＝＝＝＝ (前后都要) 例图如下：

海南蓝点

第 14 页 共 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.3方法注释规范

注意事项：

1. 事件不需要头注解，但包含复杂处理时（如：循环/数据库操作/复杂逻辑等），应分割

成单一处理函数，事件再调用函数。 2. 所有的方法必须在其定义前增加方法注释

3. 方法注释采用 /// 形式自动产生XML标签格式的注释 ///

/// /// 标记 说明 提供了一种将说明中的文本标记为代码的方法 提供了一种将多行指示为代码的方法 可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 标记的使用。 对可从当前编译环境中获取的异常的引用。 得以引用描述源代码中类型和成员的另一文件中的注释。 用于定义表或定义列表中的标题行。 备注 用于诸如