文档介绍：深圳市亚联财小额信贷有限公司
资讯科技部软件团队
C#.NET编码规范
版本序号
作者:郭亮
密级:机密
文件修改跟踪页
版次
作者
文件修改原因
日期
修改页
郭亮
文档建立
2011-07-13
新增
前言
平台下的C#程序语言编辑。
其目的在于项目在以后的编程过程中进一步规范C#软件编程风格,形成总结出一套具有特色的编成风格,从而提高软件源代码的可读性、安全性、后期维护和重复使用。便于解决在程序开发阶段中,开发人员或项目组出现调整以至重大变动中的工作转接和交接问题,减少对项目开发阶段时间的延误,方便对已编写的代码的理解,以及程序代码的后期维护和改进升级。最终提高软件源程序的开发质量和可维护性,减少项目在后期软件维护和升级的成本。
规范内容包括:代码布局、注释、命名规则、声名、表达式与语句、类与接口等。规范分成规则性和建议性两种:对于规则性规范,要求所有开发人员严格执行;对于建议性规范,要求项目程序开发人员根据实际情况选择执行。
自本规范实施之日起,项目组必须从今以后所有的程序编写和修改的代码执行本规范,项目经理和开发组长必须加以监督执行。
目录
应用程序编写规范 3
、命名原则 3
、大小写原则 3
、词汇的选择 3
、控件命名原则 4
、名字空间 5
、类和类成员 5
、枚举命名约定 6
、 ReadOnly和Const字段的命名 7
、参数的命名 7
、方法命名原则 7
、属性命名原则 8
、事件命名约定 8
、避免类型名称混乱 9
、页面代码编写原则 10
、文件内容格式 10
、代码编写原则 11
、类成员使用原则 12
、属性使用原则 12
、 Properties和Methods 14
、 Read-Only 和Write-Only 属性 15
、事件使用原则 16
、方法使用原则 16
、构造函数使用原则 18
、成员变量(Field)使用原则 19
、参数使用原则 21
、类型使用原则 22
、类的使用原则 22
、值类型使用原则 23
、接口使用原则 25
、委派使用指导 25
、错误的扔出和处理 25
、标准异常类型 27
、包装异常 28
、数组使用原则 28
、 Collection 28
、 Collection里的索引属性 28
、数组的值属性 29
、公共设计模式 29
、终结(Finalize)与清理(Dispose) 29
、线程设计原则 30
应用程序编写规范
命名原则
大小写原则
目前存在不同的大小写规范,下面列出的这些规范将在其后的章节反复引用。
Pascal Casing:每一个单词的第一个字母大写,例如:BackColor。
Camel Casing:除了第一个单词以外的每个单词的第一个字母大写,例如:backColor。
Upper case:如果缩写字母的个数小于或等于2,那么所有的缩写字母都大写。3个以上的字母缩写采用Pascal Casing。例如:
以下是程序设计时候,各种元素的命名原则:
Type
Case
Notes
Class
PascalCase
 
Enum values
PascalCase
 
Enum type
PascalCase
 
Events
PascalCase
 
Exception class
PascalCase
以 Exception结尾
Final Static field
PascalCase
 
interface
PascalCase
用大写字母 I开头
Method
PascalCase
 
Namespace
PascalCase
 
property
PascalCase
 
Public Instance Field
PascalCase
很少使用, 用在properties
Protected Instances Fields
camelCase
很少使用, 用在properties
parameter
camelCas