C#语言编码规范.doc

文档编号:SMART-DEV
版本号:
C#语言编码规范
编写:Bob 日期:2010 年12月18日
校对: 日期: 年 月 日
审核: 日期: 年 月 日
批准: 日期: 年 月 日
修订记录
类别:A –增加 M –修改 D –删除
日期
版本号
类别
描述
作者
2010-12-18

A
初稿
Bob
目录
1 介绍 4
为什么要有编码规范 4
2 文件名 5
文件后缀 5
常用文件名 5
类模块级变量定义 5
普通局部变量定义 6
常用的缩写 7
ENUM枚举 7
常量定义 8
其他需要注意的几点 8
类、接口、事件等命名规范 8
类命名规范 8
接口命名规范 9
事件命名规范 9
3 注释和缩进排版规则 10
4 、项目文件组织及命名规范 15
文件夹的组织 15
文件的组织 15
介绍
为什么要有编码规范
编码规范对于程序员而言尤为重要,有以下几个原因:
1、一个软件的生命周期中,80%的花费在于维护;
2、几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;
3、编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码;
4、如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品。
为了执行规范,每个软件开发人员必须一致遵守编码规范。每个人。
文件名
这部分列出了常用的文件名及其后缀。
文件后缀
C#程序使用下列文件后缀:
文件类别
文件后缀
Windows应用程序 C#源文件
.CS
C#程序代码文件的扩展名
.
C#语言编译后生成的组件扩展名
.DLL
常用文件名
常用的文件名包括:
文件名
用途
.XML
编译时生成XML的代码注释的文件
类模块级变量定义
如果类的私有对象跟属性对应,则私有变量以下划线(“_”)开头。在实体类编写中,如果私有变量同实体对应的数据库表的字段存在一定的对应关系,则变量的名称应该尽量跟数据库中的字段名称保持一致,比如
public class DocLib
{
private string o;
private string ame;
private double _docVersion;
private string reateDate;
private string _docLastSavedDate;
对应的属性定义,只需去掉前面的“_”符号,其他保持一致,比如:
public string o{get{return o;}set{o=value;}}
public string ame{get{return ame;}set{ame=value;}}
public double docVersion{get{return _docVersion;}set{_docVersion=value;}}
如果属性实现比较简单,则按照上面的例子,每个属性的Get和Set方法均在一行内完成。否则,就要按照严格的缩进规则编写,比如下列属性:
public PageSize Size
{
get{return _Size;}
set
{
_Size=value;
if(_Size==)
{
if(_Direction==)
{
_Width=794;
_Height=1123;
}
else
{
_Width=1123;
_Height=794;
}
}
}
}
同属性无关的类或模块级私有变量按照普通局部变量规则定义。
普通局部变量定义
普通局部变量定义由变量类型简写加变量关键字组成,变量关键字组合的每个单词的首个字母必须大写,比如:
private string strUserName;
private double dblPrice
private int intUserAge
变量关键字要求能够表示变量的实际意义。下列情况允许使用一些没有实际意义的临时局部变量:
1)用于循环体的累加器,比如
for(int i=0;i<100;i++){….
2)位于某个函数或模块的内部,并且作用范围在10行以内的,可以临时使用一些不具有实际意思的临时变量,比如:
if(==