C_编码规范.doc

C#命名规范 命名空间 框架中所有命名空间的起始部分COM.ACCP 业务中所有命名空间的起始部分COM.ASSEMBLY.FOLDER 实际结构和名称以业务为准 类 名字应该能够标识事物的特性。 名字可以有两个或三个单词组成，但通常不应多于三个。 采用Pascal case，所有单词第一个字母大写。 使用名词或名词短语命名类。 少用缩写。 不要使用下划线字符 (_)。 例： public class FileStream public class Button 接口 和类命名规范相同，唯一区别是接口在名字前加上“I”前缀 例： interface IDBCommand interface IButton 枚举 和类命名规范相同，唯一区别是枚举在名字前加上“E”前缀 例： enum ESystemType 方法 使用动词或动词短语命名方法。 采用Pascal case，所有单词第一个字母大写。 方法中的参数命名采用Camel casing,所有单词第一个字母大写，除了首字母小写。 属性 使用名词或名词短语命名 采用Pascal case，所有单词第一个字母大写 少用缩写 不要使用下划线字符( _ ) 变量 变量名称 = 变量的前缀 + 代表变量含意的英文单词或单词缩写。 常用变量类型的前缀命名规则，定义如下： 类型前缀boolblnbytebytcharchardoubledblfloatfltintegerintlonglngobjectobjstringstr 常用对象: 类型前缀CollectioncollDateTimedtDataSetdsDataReaderdrdDataRowdrDataColumndcHashtablehsXmlDomxmlXmlReaderxr 类的私有变量，在遵循第一条规则后，在其前加“m_”前缀。 例: public class Hello { private string m_strName; public string Name { get { return m_strName; } } } 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名称。仅对于短循环索引使用单字母变量名，如 i 或 j。 不要使用原义数字或原义字符串，如for(int i = 1;i = 7;i++)。而是使用命名常数，如for(int i = 1;i = NUM_DAYS_IN_WEEK;i++)以便于维护和理解。 常量 常量的名字应该都大写，并且指出完整含义，单词之间用下划线（_）分隔。 例： const int PAGE_COUNT = 10; 控件 前台系统开发时，只能使用下面列出的控件，又不能满足要求请先和模块负责人联系。讨论通过后才可使用，规范修改前严禁使用未列出的控件。Framework有提供相应控件的，不得使用.Net标准控件 控件命名 = Window控件缩写前缀 + 变量名 控件类型命名ButtonBtnCheckBoxChkComboBoxCmbDateTimeBoxDtbGroupBoxGrbLabelLblLookupBoxLkpNumericBoxNumPanelPnlProgressBarPgbRadioButtonRadTextBoxTxtMemoEditMemoTreeViewTvwDataGridGridDataListListImageImgDropDownListDrp 数据集命名规范 普通数据集命名以Ds开头 作为查询参数的数据集命名以DsQuery开头，表名以QUERY_为前缀 元素的所有字母大写，各字母以下划线“_”分割 专用名词建议使用习惯缩写 与后台交互的数据集不允许使用属性 注释 注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范 类注释规范 类开始必须以以下形式书写类注释： ///summary ///类的描述: ///作者： ///创建时间：格式：YYYY-MM-DD ////summary 类属性注释规范 在类的属性必须以以下格式编写属性注释： /// summary /// 属性说明: /// /summary 方法注释规范 在类的方法声明前必须以以下格式编写注释 /// summary /// 说明：对该方法的说明 /// /summary /// param name=参数名称参数说明/param /// returns ///对