浅谈C#程序编码规范

编码规范

1>.命名规则

名称空间

命名名称空间的一般规则如下：

使用Pascal大小写方式，用逗号分隔逻辑成分。
CompanyName.TechnologyName：即公司名.项目名。例如：Microsoft.Office

 

类和类成员

命名类和类中成员的一般规则如下：

1.类的命名原则

使用Pascal大小写方式，用名词或名词短语命名类。

减少类名中缩写的使用量。不要使用任何类前缀（比如C），不要使用带下划线的字符。例如： public class FileStream {}
2.字段命名原则

私有字段以camel大小写方式并在其前加一条下划线，例如：_employeeSalary

共有字段使用Pascal大小写方式，例如：EmployeeSalary

3.函数命名原则

私有函数使用camel大小写方式，不要使用带下划线的字符。例如：privite void closeDialog(){}

共有函数使用Pascal大小写方式，不要使用带下划线的字符。函数和方法的命名应该以动词开始。例如：public void CloseDialog(){}

函数的参数命名使用camel大小写方式，名称使用具有描述性的参数名。参数名应该具有足够的描述性，这样在大多数情况下参数名和它的种类可以用来确定它的意思。例如：Type GetType (string typeName)

 

变量

命名变量的一般规则如下：

使用camel大小写方式，不要使用带下划线的字符。例如：int findLastRecord=0;

 

接口命名

命名接口的一般规则如下：

使用Pascal大写，使用名词或名词短语，或者描述行为的形容词来命名接口。 减少接口名中缩写的使用量，在接口名前加前缀I，以表示这个类型是一个接口。例如： IComponent（描述性名词）

 

事件的命名

命名事件的一般规则如下：

用EventHandloer后缀命名事件处理程序，使用名为sender和e的两个参数。

命名事件名时，需要有之前和之后的时态概念，因此要使用现在时态和过去时态(不要使用BeforeXxx\\AfterXxx的方式)。例如，可以被取消的结束事件就有Closing事件和Closed事件,例如：

public delegate void MouseEventHandler(object sender, MouseEvent e);

2>.代码注释规范

.cs文件的注释
所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等
例如：

//********************************************************

//新增日期:2004.7.19

//作者:XXX

//內容说明:　XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

//********************************************************

 

函数过程注释
所有的函数体开头都要加上注释，所以注释使用.NET注释规范。
例如：

/// <summary>

/// 构造函数

/// </summary>

/// <param name='is_xxx1'>示例参数1</param>

/// <param name='is_xxx2'>示例参数2</param>

public UpgradeThread(string is_xxx1, string is_xxx2)

{

//…
}

 

常量变量注释
所有的常量变量，无论是全局还是局部使用的，凡是对代码整体起到关键性做用的都需要加上注释。
例如：

/// <summary>

/// 当前线程指向的备份文件本地保存路径

/// </summary>

public string storePath = '';

 

代码修改注释
当开发者维护以前的程序代码时，需要在修改处的开始及结尾，加上自己的注释信息。
例如：

//BEGIN 2014-7-27 zhangyu　修正了XXX问题
略…

//END 2014-7-27 zhangyu

转载于:https://www.cnblogs.com/zyu19890106/articles/3871811.html