项目编码规范.docx

编号：时间：2021年x月x日书山有路勤为径学海无涯苦作舟页码：项目开发规则C#命名规范命名空间框架中所有命名空间的起始部分COM.ACCP业务中所有命名空间的起始部分COM.ASSEMBLY.FOLDER实际结构和名称以业务为准类名字应该能够标识事物的特性。名字可以有两个或三个单词组成但通常不应多于三个。采用Pascalcase所有单词第一个字母大写。使用名词或名词短语命名类。少用缩写。不要使用下划线字符(_)。例：publicclassFileStreampublicclassButton接口和类命名规范相同唯一区别是接口在名字前加上“I”前缀例：interfaceIDBCommandinterfaceIButton枚举和类命名规范相同唯一区别是枚举在名字前加上“E”前缀例：enumESystemType方法使用动词或动词短语命名方法。采用Pascalcase所有单词第一个字母大写。方法中的参数命名采用Camelcasing所有单词第一个字母大写除了首字母小写。属性使用名词或名词短语命名采用Pascalcase所有单词第一个字母大写少用缩写不要使用下划线字符(_)变量变量名称=变量的前缀+代表变量含意的英文单词或单词缩写。常用变量类型的前缀命名规则定义如下：类型前缀boolblnbytebytcharchardoubledblfloatfltintegerintlonglngobjectobjstringstr常用对象:类型前缀CollectioncollDateTimedtDataSetdsDataReaderdrdDataRowdrDataColumndcHashtablehsXmlDomxmlXmlReaderxr类的私有变量在遵循第一条规则后在其前加“m_”前缀。例:publicclassHello{privatestringm_strName;publicstringName{get{returnm_strName;}}}即使对于可能仅出现在几个代码行中的生存期很短的变量仍然使用有意义的名称。仅对于短循环索引使用单字母变量名如i或j。不要使用原义数字或原义字符串如for(inti=1;i<=7;i++)。而是使用命名常数如for(inti=1;i<=NUM_DAYS_IN_WEEK;i++)以便于维护和理解。常量常量的名字应该都大写并且指出完整含义单词之间用下划线（_）分隔。例：constintPAGE_COUNT=10;控件前台系统开发时只能使用下面列出的控件又不能满足要求请先和模块负责人联系。讨论通过后才可使用规范修改前严禁使用未列出的控件。Framework有提供相应控件的不得使用.Net标准控件控件命名=Window控件缩写前缀+变量名控件类型命名ButtonBtnCheckBoxChkComboBoxCmbDateTimeBoxDtbGroupBoxGrbLabelLblLookupBoxLkpNumericBoxNumPanelPnlProgressBarPgbRadioButtonRadTextBoxTxtMemoEditMemoTreeViewTvwDataGridGridDataListListImageImgDropDownListDrp数据集命名规范普通数据集命名以Ds开头作为查询参数的数据集命名以DsQuery开头表名以QUERY_为前缀元素的所有字母大写各字母以下划线“_”分割专用名词建议使用习惯缩写与后台交互的数据集不允许使用属性注释注释规范包括：类注释规范、类的属性、方法注释规范、代码间注释规范类注释规范类开始必须以以下形式书写类注释：///<summary>///类的描述:///作者：///创建时间：<格式：YYYY-MM-DD>///</summary>类属性注释规范在类的属性必须以以下格式编写属性注释：///<summary>///属性说明:///</summary>方法注释规范在类的方法声明前必须以以下格式编写注释///<summary>///说明：<对该方法的说明>///</summary>///<paramname="<参数名称>"><参数说明></param>///<returns>///<对方法返回值的说明>///</returns>代码间注释规范代码间注释分为单行注释和多行注释：单行注释：//<单行注释>多行注释：/*多行注释1多行注释2多行注释3*/C#代码格式规范所有的缩进为4个空格使用VS.N