(编码规范整理.docVIP

使用VS2005 C＃.NET编码规范整理 环境设置 首先去除开发环境中的一些选项如下： 图一 图二 命名规范 通用性 标识的总长度不要超过32个字符。 标识符的基本语法是以字母和_开始，由字母数字及下划线组成的单词，第一个字符不能是数字。 只要合适，在变量名的末尾追加计算限定符（Avg、Sum、Min、Max、Index）。在变量名中使用互补对，如 min/max、begin/end 和 open/close。布尔变量名应该包含 Is尽量减少使用缩写，而是使用以一致方式创建的缩写。缩写应该只有一个意思；同样，每个缩写词也应该只有一个缩写。例如，如果用 min 作为 minimum 的缩写，那么在所有地方都应这样做；不要将 min 又用作 minute 的缩写。在命名函数时包括返回值的说明，如 GetCurrentWindowName()。避免对不同的元素重用名称，如名为 ProcessSales() 的例程和名为 iProcessSales 的变量。在命名元素时避免同音异义词（如 write 和 right），以防在检查代码时发生混淆。在命名元素时，避免使用普遍拼错的词。另外，应清楚区域拼写之间存在的差异，如 color/colour 和 check/cheque。在内部范围中避免使用与外部范围中的名称相同的名称。若访问错误变量，则会产生错误结果。若变量与同一名称的关键字冲突，则必须在关键字前加适当的类型库以作标识。例如，若有一个名为 date 的变量，只能通过调用 System.Date 来使用内部 Date 函数。接口名称以前缀“I”开始，后面接一个名词或名词词组（如 IComponent），或者接一个描述接口行为的形容词（如 IPersistable）。不要使用下划线，不要过多使用缩写，因为缩写会引起混淆。事件处理程序的名称以一个描述事件类型的名词开始，后面接后缀“EventHandler”，如“MouseEventHandler”。 事件参数类的名称里要加“EventArgs”后缀。如果某事件含有“之前”或“之后”的概念，请以现在时或过去时形式使用前缀，如“ControlAdd”或“ControlAdded”。不要给存储过程加sp 前缀不要给用户定义的函数加 fn_ 前缀不要给扩展存储过程加 xp_ 前缀这前缀是为标识系统保留的。不要使用原义数字或原义字符串，如 For i = 1 To 7。而是使用命名常数，如 For i = 1 To NUM_DAYS_IN_WEEK 以便于维护和理解。private int _PageSize;// 类属性对应的私有变量 public int PageSize { set { _PageSize = value; } }//类属性 注意大小写要保持一致。每个单词的第一个字母必须大写。其它单词的第一个字母也大写。单词之间不加“_”。 不要使用public来定义一个属性。 属性名和类名以名词开始，如 EmployeeName 和 CarAccessory。string _strSQL = null; 第一个单词的第一个字母必须小写，其它单词第一个字母大写。单词之间不加“_”。 长期性（类私有变量/方法入口参数） 类私有变量：前加“_”，和类属性对应的私有变量一样。每个单词的第一个字母必须大写。其它单词的第一个字母也大写。单词之间不加“_”。 如：private int _PageSizeTmp; 方法入口参数：第一个单词的第一个字母必须小写，其它单词的第一个字母必须大写。如果只有一个单词组成全小写。单词之间不加“_”。 如：public static int SendCTTVOSMS(string mobile,string content) public static string CallAccountHiVA(string restPhone,string userPhone) 全局变量/静态变量/常量 定义要全部大写。如：public static int SMS_TYPE = 2; 定义部分也可小写。 如：public static string VOSMS_UserName = 单词与单词之间加“_”分隔。 函数命名 函数命名规则：动词+名词（或动词），每个单词第一个字母必须大写。单词之间不加“_”。 如：public static string GetOrderStatus(int sendMode,int statueID) 函数名和方法名以动词开始，如 InitNameArray 和 CloseDialog。Sbyte b Byte n/i Int ui Uint l Long ul Ulong f Float