Net项目代码编写规范

目录TOC\o"1-5"\h\zC#代码风格要求3注释3类型（类、结构、委托、接口）、字段、属性、方法、事件的命名3不使用缩写4代码使用半展开4使用Tab作为缩进，并设置缩进大小为45一个.cs源文件至多定义两个类型7类型名称和源文件名称必须一致7所有命名空间、类型名称使用Pascal风格（单词首字母大写）7本地变量、方法参数名称使用Camel风格（首字母小写，其后每个单词的首字母大写）7私有方法、受保护方法，仍使用Pascal风格命名8如果if语句内容只有一行，可以不加花括号，但是必须和if语句位于同一行……8调用类型内部其他成员，需加this；调用父类成员，需加base9类型内部的私有和受保护字段，使用Camel风格命名，但加“，前缀9不能出现公有字段10类型成员的排列顺序10委托和事件的命名11返回bool类型的方法、属性的命名11常见集合类型后缀命名12常见后缀命名12常见类型命名13常见字段、属性命名14XHTML代码风格要求14如果XHTML标记有层次，那么代码也要有层次14所有标记必须闭合15如果标记中间代码超过20行，则应在标记末尾加注标识15CSS代码风格要求16代码使用半展开16使用Tab作为缩进，并设置缩进大小为416代码注释16代码编写16嵌入式样式的比例不超过样式表代码总量的10%17内联式样式的比例不超过样式表代码总量的30%17外联式样式表的比例不少于样式表代码总量的60%17JavaScript代码风格要求18代码使用半展开18使用Tab作为缩进，并设置缩进大小为418代码注释18不得出现内嵌式代码18内联式代码占JavaScript的总量不得超过40%1819外联式代码占JavaScript的总量至少为60%191.C#代码风格要求注释类型、属性、事件、方法、方法参数，根据需要添加注释。如果类型、属性、事件、方法、方法参数的名称已经是自解释了，不需要加注释；否则需要添加注释。当添加注释时，添加方式如下图所示：namespaceConsoleApp{///<summary>///产品售光时被调用的委托///</summarv>publicdelegatevoidSalesOutEventHandler()■///<summary>///产品类，菊述产品的基本信息///</summarv>publicclassProduct{///<sunmary>///定义产品.售光时的处理逻辑///</surrmary>publice^entSalesOutEventHandlerOnSalesOut:1WWWWWWW\Jill<sunmary>HI根据产品工d查找产品///</surrmary>///<paramnamc="icT>产品的工北/para心///"£七urn5》符合此工旃产品实例,当不存在该产品时「返回nuLL<"Etu「nQpublicProductGe±Pr0ductById(intid)\returnnewProduct()■)///<sunmary>”/产品类型：描述产品种类.参考《需求说明))///</surrmary>publicenunProductlype{).类型(类、结构、委托、接口)、字段、属性、方法、事件的命名优先考虑英文，如果英文没有合适的单词描述，可以使用拼音，使用中文是不符合要求的。唯一可以使用中文的地方是枚举的枚举项，枚举项实际已经不属于本节标题的范畴了。这里只是放到一起说明，如下图所示：publicenunProduct?ype未定义=0j服装=1,数码=2不使用缩写所有类型、方法、参数、变量的命名不得使用缩写，包括大家熟知的缩写，例如代码使用半展开第一步，打开，进入“工具”，“选项”，如下图所示:工具E泳试⑸体率结构©分析(N)育口皿帮助(H)#的to口到进程网…Ctrl+Alt4-P*T病到螃库⑪曾服相㈤…成融1匚SharePciint.安代用段管理器由…Ctrl+KJ-Ctrl4-B邮工具箱项凶…多朦程序管理器〔用…库程序包管理器g)圜扩展和更新(U)…创建GUID(G]PreEmptiveDotfuacatorandAnalyticsSpy++(工64]变WCF服务配置编号器(W)第二步，进入“文本编辑器”，“”,“格式设置”，“新行”，取消掉右侧所有复选框中的对号，如下图所示:K、山v,,,,yc/仪以j^l。>R—^,,使用作为缩进，并设置缩进大小为第一步，打开,进入“工具”，“选项”.如下图所示:工具E^试⑸体茎结枸©分析(H)窗口(W)帮助#附b口到迸程Ctrl+AJt+P*rg库⑪…曾服务器图…[57iSbCSharePaint...雷代班段管理器CD，,，Ctrl+K,Ctrl4-B些工具箱项凶.，，少骸程序管理器(用…库程序包营里器国扩展和更新(U)…创建GUIDfGDPreEmptiveDotfuscatorandAnalyticsSpy++(x64)丽WCF服务■配置编辑器fW]外部工具㈤…导人和导td设置⑴…自定义⑷…0选项@.“第二步，进入“文本编辑器”，"”,“制表符”，如下图所示，设置制表符。第三步，点击“确定”，完成设置。一个源文件至多定义两个类型如果两个类型的关系是紧密相关的，比如产品、产品类型，此时类，和枚举可以定义在同一个文件中。但不能在一个文件中出现两个不相关的类型定义，例如将类和类（分销商）定义在一个文件中。类型名称和源文件名称必须一致当类型命名为时，其源文件命名只能是c所有命名空间、类型名称使用风格（单词首字母大写）如下图所示，红色标记的为使用风格的类型:namespace|Ccjn与cjlE/Xpppublicdelegatevoid15日工emOijt:E%En~tzHariclJ.e「上)■publicclass[Product|{publiceventpublicProduct[GEizLLCJcIuKztiByHd[int:id){returnnull;privateenumP「cjdu<z~t:Typc]]}注意是私有类型，不管类型是公有的还是私有的，其命名总是采用风格。本地变量、方法参数名称使用风格（首字母小写，其后每个单词的首字母大写）

红色标记的为使用风格的变量或者方法参数:红色标记的为使用风格的变量或者方法参数:publicclassProduct{publicfloatPrice-{get;setj}publicfloatCie-PrcjductPri匚已(zLniz-{Producti±em=±his.GetProductByld(productld);-floatfprice|=item.Priceyif(price<100)■{returnprice;}else■{returnprice*0.95fjpublicProductGetProductBylcHintid)■{re±urnnewProduct()j私有方法、受保护方法，仍使用风格命名私有方法、受保护方法，仍使用风格命名示例代码如下:publicclassProduct{publicfloatPrice{getjset;}p-r-ivatefloatRetProdiu£IzPr1j汇总］productld){return0;}'proteftedProductGetProductByldllintid){r-e-turnnull;}'}如果语句内容只有一行，可以不加花括号，但是必须和语句位于同一行范例中的判断实际上与下面的语句是等效的:pf_(price_>=100)~re±urn_price_~0.95fjIreturnprice■调用类型内部其他成员，需加；调用父类成员，需加示例代码如下:publicclass3roductBase{protectedProductGetProductByld(intid){returnnew3尸ciduct();publicclass3roduct:^roductBase(publicFloatPrice{get;set;}publicFloatGetProductPrice(intid){Productitem=|匕日.GetPrcjdu-tBy工d(id)returnIthis.CalculatePrice(item);privateFloatCalculatePrice(^r-oductitem){floatprice=item.Price;IF(price>=100)returnprice*0.95F;returnprice;}}类型内部的私有和受保护字段，使用风格命名，但加“”前缀代码示例如下:publicclassProduct(protectedfloat|_id;|privateFloat]_pr"i";]不能出现公有字段如果需要公有字段，使用属性进行包装。类型成员的排列顺序类型成员的排列顺序自上而下依次为：字段：私有字段、受保护字段属性：私有属性、受保护属性、公有属性事件：私有事件、受保护事件、公有事件构造函数：参数数量最多的构造函数，参数数量中等的构造函数，参数数量最少的构造函数方法：重载方法的排列顺序与构造函数相同，从参数数量最多往下至参数最少。publicclassProduct{privateintfieldl:protectedint_field2■privateint_pr,opertyl{get-set-}protectedint_propertyi{get-set-}publicintProperty3{get-set■}privateSalesOutEventHandlereventl:protectedSalesOutEventHandler_event2■publicSalesOutEventHandlerEventsjpublicProduc±(intparamljintparam?){}publicProduc±(intparaml){}publicProduct(){}publicProduct■GetProduct(intidjstringarea){returnnull;}publicProduct■GetProduct(intid)-{re±urnnull■)publicProduct€etProduct()(returnnull;}委托和事件的命名委托以作为后缀命名，例如。事件以其对应的委托类型，去掉后缀，并加上前缀构成。例如，对于委托类型的事件，其事件名称为：示例代码如下：publicdelegatevoidSalesOutEventHandler(}-publicclassProduct{publicSalesOu±EventHandler011-31£5口11七;返回类型的方法、属性的命名如果方法返回的类型为类型，则其前缀为如果方法返回的类型为类型，则其前缀为或者，例如:publicclassProduct{publicboolIsSa1esOut{get{returntruej)}^publicboolTrylLIeid){returntrue;}publicbool|CanSale[irtid){retur-ntrue;}}常见集合类型后缀命名凡符合下表所列的集合类型，应添加相应的后缀。说明后缀示例数组列表字典中的常见后缀命名凡符合下表所列的局部变量、方法参数、字段、属性，均需添加相应的后缀。说明后缀示例示例说明费用相关运输费价格相关产品单价消息相关（弃用）成功消息日期相关（弃用）下单日期计数、数量相关（弃用）登录次数链接地址相关博客链接图片相关签名图片

金额相关预付款点数、积分相关会员积分记录、日志相关（弃用）错误记录配置相关数据库配置状态相关订单状态模式、方式相关打开方式种类相关二/一用户种类工厂类相关连接工厂启用相关开启导出流相关上传流读取器相关读取器写入器相关写入器适配器相关适配器提供器相关会员信息提供器包装器相关包装器连接相关连接常见类型命名凡存在下表中的类型，需采用下表指定的名称命名。类型命名类型命名客户分销商零售商经销商批发商用户I为数据库关键字）订单（oe弃据库关键字）供应商管理员密码会员评论（弃用）文章新闻发票导入导出

公司、企业（弃用）产品省份城市区县地址角色（弃用）权限（弃用）仓库工厂登录（弃用）登出（弃用）创建（弃用）编辑更新删除（弃用）照片图片常见字段、属性命名字段、属性种类比较繁杂，因此仅列出最常用的几项。类型名称类型名称d型）（“”小写，弃用）（型（名称标题备注、描述（弃用、）种类（弃用（）联系人.XHTML代码风格要求如果标记有层次，那么代码也要有层次下面是书写符合要求的例子:<±able><tr><td>Sinbsp;</1zd><td>Sinbsp;</td></tr><tr><td>Sinbsp;</td><td>Sinbsp;</izd></tr></-table>下面是书写不符合要求的例子:<table><±r><td>-8cnbsp;</±d><td>S：nbsp;</±d>/tr>tr>td>S：nbsp;</td>td>S：nbsp;</td></±r></-table>所有标记必须闭合示例代码如下:<bir-/><imgsrc=u..."alt=''''/>如果标记中间代码超过行，则应在标记末尾加注标识标注方式如下:<divid='rcontainer"><1--省略2g行代码一》</div><!--container--><divclass="footsr"><1--省咯2g行代码一》</div>j<!--，口口terCSS代码风格要求代码使用半展开设置方法参考节。使用作为缩进，并设置缩进大小为设置方法参考节。代码注释注释主要说明该样式应用于页面的哪个部分，而非说明样式的应用效果，代码注释风格如下所示：代码编写

每一个样式设置必须独占一行，不能位于同一行，下面是符合要求的写法:#container(■f-ont-size:14px;border:lpxsolidred;}下面是不符合要求的写法:#corrtairer{■font-size:14px;border:Ipxsolidred;嵌入式样式的比例不超过样式表代码总量的嵌入式样式为直接写在标记内部的样式，如下图所示:<bodystyle=Rrbackground:#-FF-F;,r>内联式样式的比例不超过样式表代码总量的内联式样式为写在中的样式，如下图所示:<head><styletype='rtext/css">#container{font-size:L4px;border:lpxsolidred;}</head>内联式样式，不能写在之