Net综合项目代码编写标准规范

目录1.C#代码风格规定 31.1注释 31.2类型（类、构造、委托、接口）、字段、属性、办法、事件命名 31.3不使用缩写 41.4代码使用半展开 41.5使用Tab作为缩进，并设立缩进大小为4 51.6一种.cs源文献至多定义两个类型 71.7类型名称和源文献名称必要一致 71.8所有命名空间、类型名称使用Pascal风格（单词首字母大写） 71.9本地变量、办法参数名称使用Camel风格（首字母小写，其后每个单词首字母大写） 71.10私有办法、受保护办法，仍使用Pascal风格命名 81.11如果if语句内容只有一行，可以不加花括号，但是必要和if语句位于同一行 81.12调用类型内部其她成员，需加this；调用父类成员，需加base 91.13类型内部私有和受保护字段，使用Camel风格命名，但加“_”前缀 91.14不能浮现公有字段 101.15类型成员排列顺序 101.16委托和事件命名 111.17返回bool类型办法、属性命名 111.18常用集合类型后缀命名 121.19常用后缀命名 121.20常用类型命名 131.21常用字段、属性命名 142.XHTML代码风格规定 142.1如果XHTML标记有层次，那么代码也要有层次 142.2所有标记必要闭合 152.3如果标记中间代码超过20行，则应在标记末尾加注标记 153.CSS代码风格规定 163.1代码使用半展开 163.2使用Tab作为缩进，并设立缩进大小为4 163.3代码注释 163.4代码编写 163.5嵌入式样式比例不超过样式表代码总量10% 173.6内联式样式比例不超过样式表代码总量30% 173.7外联式样式表比例不少于样式表代码总量60% 174.JavaScript代码风格规定 184.1代码使用半展开 184.2使用Tab作为缩进，并设立缩进大小为4 184.3代码注释 184.4不得浮现内嵌式代码 184.5内联式代码占JavaScript总量不得超过40% 184.6外联式代码占JavaScript总量至少为60% 19

1.C#代码风格规定1.1注释类型、属性、事件、办法、办法参数，依照需要添加注释。如果类型、属性、事件、办法、办法参数名称已经是自解释了，不需要加注释；否则需要添加注释。当添加注释时，添加方式如下图所示：1.2类型（类、构造、委托、接口）、字段、属性、办法、事件命名优先考虑英文，如果英文没有适当单词描述，可以使用拼音，使用中文是不符合规定。唯一可以使用中文地方是枚举枚举项，枚举项实际已经不属于本节标题范畴了。这里只是放到一起阐明，如下图所示：1.3不使用缩写所有类型、办法、参数、变量命名不得使用缩写，涉及人们熟知缩写，例如msg。1.4代码使用半展开第一步，打开VisualStudio，进入“工具”，“选项...”，如下图所示：第二步，进入“文本编辑器”，“C#”，“格式设立”，“新行”，取消掉右侧所有复选框中对号，如下图所示：第三步，点击“拟定”，完毕设立。1.5使用Tab作为缩进，并设立缩进大小为4第一步，打开VisualStudio，进入“工具”，“选项...”，如下图所示：第二步，进入“文本编辑器”，“C#”，“制表符”，如下图所示，设立制表符。第三步，点击“拟定”，完毕设立。1.6一种.cs源文献至多定义两个类型如果两个类型关系是紧密有关，例如产品、产品类型，此时Product类，和ProductType枚举可以定义在同一种Product.cs文献中。但不能在一种.cs文献中浮现两个不有关类型定义，例如将Product类和Reseller类（分销商）定义在一种BasicInfo.cs文献中。1.7类型名称和源文献名称必要一致当类型命名为Product时，其源文献命名只能是Product.cs。1.8所有命名空间、类型名称使用Pascal风格（单词首字母大写）如下图所示，红色标记为使用Pascal风格类型：注意ProductType是私有类型，不论类型是公有还是私有，其命名总是采用Pascal风格。1.9本地变量、办法参数名称使用Camel风格（首字母小写，其后每个单词首字母大写）红色标记为使用Camel风格变量或者办法参数：1.10私有办法、受保护办法，仍使用Pascal风格命名示例代码如下：1.11如果if语句内容只有一行，可以不加花括号，但是必要和if语句位于同一行范例1.9中if判断事实上与下面语句是等效：1.12调用类型内部其她成员，需加this；调用父类成员，需加base示例代码如下：1.13类型内部私有和受保护字段，使用Camel风格命名，但加“_”前缀代码示例如下：1.14不能浮现公有字段如果需要公有字段，使用属性进行包装。1.15类型成员排列顺序类型成员排列顺序自上而下依次为：字段：私有字段、受保护字段属性：私有属性、受保护属性、公有属性事件：私有事件、受保护事件、公有事件构造函数：参数数量最多构造函数，参数数量中档构造函数，参数数量至少构造函数办法：重载办法排列顺序与构造函数相似，从参数数量最多往下至参数至少。1.16委托和事件命名委托以EventHandler作为后缀命名，例如SalesOutEventHandler。事件以其相应委托类型，去掉EventHandler后缀，并加上On前缀构成。例如，对于SalesOutEventHandler委托类型事件，其事件名称为：OnSalesOut。示例代码如下：1.17返回bool类型办法、属性命名如果办法返回类型为bool类型，则其前缀为Is、Can或者Try，例如：1.18常用集合类型后缀命名凡符合下表所列集合类型，应添加相应后缀。阐明后缀示例数组Arrayint[]productArray列表ListList<Product>productListDataTable/HashTableTableHashTableproductTable字典DictionaryDictionay<string,string>productDictionaryEF中DbSet/DataSetSetDbSet<Product>productSet1.19常用后缀命名凡符合下表所列局部变量、办法参数、字段、属性，均需添加相应后缀。阐明后缀示例示例阐明费用有关CostShipCost运送费价格有关PriceProductUnitPrice产品单价消息有关Message（弃用Note）SuccessMessage成功消息日期有关Date（弃用Time）OrderDate下单日期计数、数量有关Count（弃用Time）LoginCount登录次数链接地址有关UrlBlogUrl博客链接图片有关ImageSignImage签名图片金额有关AmountPrepaidAmount预付款点数、积分有关PointMemberPoint会员积分记录、日记有关Record（弃用Log）ErrorRecord错误记录配备有关ConfigDataBaseConfig数据库配备状态有关StatusOrderStatus订单状态模式、方式有关ModeOpenMode打开方式种类有关Category/Type二选一UserCategory顾客种类工厂类有关FactoryConnectionFactory连接工厂启用有关EnabledExportEnabled启动导出流有关StreamUploadStream上传流读取器有关ReaderExcelReaderExcel读取器写入器有关WriterExcelWriterExcel写入器适配器有关AdapterIntroOPAdapterIntroOP适配器提供器有关ProviderMemebershipProvider会员信息提供器包装器有关WrapperProductWrapperProduct包装器连接有关ConnectionExcelConnectionExcel连接1.20常用类型命名凡存在下表中类型，需采用下表指定名称命名。类型命名类型命名客户Customer分销商Reseller零售商Retailer经销商/批发商Dealer顾客UserInfo（User为数据库核心字）订单OrderInfo（Order为数据库核心字）供应商Supplier管理员Admin密码Password会员Member评论Remark（弃用Comment）文章Article新闻News发票Invoice导入Import导出Export公司、公司Company（弃用Enterprise）产品Product省份Province都市City区县District地址Address角色Role（弃用Group）权限Authority（弃用Permission）仓库Warehouse工厂Plant登录Login（弃用SignIn）登出LogOut（弃用SignOut）创立Create（弃用Add）编辑Edit更新Update删除Remove（弃用Delete）照片Photo图片Image1.21常用字段、属性命名字段、属性种类比较繁杂，因而仅列出最惯用几项。类型名称类型名称Id（int型）Id（“d”小写，弃用ID）GuidId（Guid型）IdName名称Title标题Remark备注、描述（弃用Memo、Description）Category种类（弃用Class、Type）Linkman联系人

2.XHTML代码风格规定2.1如果XHTML标记有层次，那么代码也要有层次下面是书写符合规定例子：下面是书写

不符合规定

例子：2.2所有标记必要闭合示例代码如下：2.3如果标记中间代码超过20行，则应在标记末尾加注标记标注方式如下：3.CSS代码风格规定3.1代码使用半展开设立办法参照1.4节。3.2使用Tab作为缩进，并设立缩进大小为4设立办法参照1.5节。3.3代码注释注释重要阐明该样式应用于页面哪个某些，而非阐明样式应用效果，代码注释风格如下所示：3.4代码编写每一种样式设立必要独占一行，不能位于同一行，下面是符合规定写法：下面是

不符合规定

写法：3.5嵌入式样式比例不超过样式表代码总量10%嵌入式样式为直接写在HTML标记内部样式，如下图所示：3.6内联式样式比例不超过样式表代码总量30%内联式样式为写在<head></head>中样式，如下图所示：内联式样式，不能

写在<body></body>之间。3.7外联式样式表比例不少于样式表代码总量60%外联式样式表为写在.css文献中样式，通过link引入到XHTML页面中，如下图所示：4.JavaScript代码风格规定4.1代码使用半展开设立办法参照1.4节。4.2使用Tab作为缩进，并设立缩进大小为4设立办法参照1.5节。4.3代码注释代码注释需要阐