C#代码开发命名规范示例

1、.代码开发命名规范拟稿该规范的制定致力于规范代码格式，提高开发效率，保证程序质量，最终解释权归*软件开发组。1. 项目名称及类库命名规范项目名称： testlatform, 简写 test实体类类库命名：test.model业务逻辑类类库命名：test.bll数据工厂类类库命名：test.dalfactory数据库帮助类类库命名：test.dbutility数据接口类类库命名：test.idal数据访问层类类库命名：test.sqlserverdal常用帮助类类库命名：test.utils表现层类库命名：test.ui2. 数据库名称及字段命名规范1） 数据库命名数据库命名：同项目名称简写（t

2、est）2 ） 实体（表）命名规则：前缀 _ 表存储内容简称 举例：sys_user【系统用户表】sys_role【角色表】3 ） 属性（列）命名规则：前缀 + 列存储内容简称 举例：userid【用户编号】 useridrolename【角色名称】4 ） 视图命名：规则：视 图 以 v 作 为 前 缀 ， 其 他 命 名 规 则 和 表 的 命 名 类 似 ；命名应尽量体现各视图的功能。举例：v_getuserloginfo【获取用户的登录信息】;.5 ） 触发器的命名规则：触发器以tr作为前缀，触发器名为相应的表名加上后缀，insert触发器加 _i ， delete 触发器加 _d ，

3、update 触发器加 _u ，举例：tr_user_i【添加用户时激发】6 ） 存储过程命名规则：存储过程应以up_ 开头，和系统的存储过程区分，后续部分以存储过程内容加存储过程的动作构成（参考动软代码生成器生成存储过程的规则），并用下划线分割各个组成部分。举例：up_sys_user_update【更新系统用户信息】7） 变量命名规则：变量名采用小写，若属于词组形式，用下划线分隔每个单词，举例：my_err_no。8 ） 命名中其他注意事项a.以上命名都不得超过30 个字符的系统限制。变量名的长度限制为29（不包括标识字符 ）。b. 数据对象、变量的命名都采用英文字符，禁止使用中文命名。绝

4、对不要在对象名的字符之间留空格。c. 小心保留词， 要保证你的字段名没有和保留词、 数据库系统或者常用访问方法冲突d. 保持字段名和类型的一致性， 在命名字段并为其指定数据类型的时候一定要保证一致性。 假如数据类型在一个表里是整数， 那在另一个表里可就别变成字符型了。3. 项目代码命名规范1) ado.net命名规范注释：动软代码生成器生成的逻辑代码除外。数据类型数据类型简写标准命名举例connectionconconnorthwindcommandcmdcmdreturnproductsparameterparmparmproductid;.dataadapterdaddadproducts

5、datareaderdtrdtrproductsdatasetdstdstnorthwinddatatabledtbldtblproductdatarowdrowdrowrow98datacolumndcoldcolproductiddatarelationdreldrelmasterdetaildataviewdvwdvwfilteredproducts2)webcontrol命名规范web控件名简写标准命名举例adrotatoradrtadrtexamplebuttonbtnbtnsubmitcalendarcalcalmettingdatescheckboxchkchkbluecheck

6、boxlistchklchklfavcolorscomparevalidatorvalcvalcvalidagecustomvalidatorvalxvalxdbcheckdatagriddgrddgrdtitlesdatalistdlstdlsttitlesdropdownlistdropdropcountrieshyperlinklnklnkdetailsimageimgimgauntbettyimagebuttonibtnibtnsubmitlabellbllblresultslinkbuttonlbtnlbtnsubmitlistboxlstlstcountriespanelpnlpn

7、lform2placeholderplhplhformcontentsradiobuttonradradfemaleradiobuttonlistradlradlgenderrangevalidatorvalgvalgageregularexpressionvalevaleemail_validatorrepeaterrptrptqueryresults;.requiredfieldvalidatorvalrvalrfirstnametabletbltblcountrycodestablecelltblctblcgermanytablerowtblrtblrcountrytextboxtxtt

8、xtfirstnamevalidationsummaryvalsvalsformerrorsxmlxmlcxmlctransformresults3) html 控件命名规则html 控件名简写标准命名举例htmlanchorhahhahuserdetialhtmlbuttonhbtnhbtnconfirmhtmlformhformhformfromuserhtmlgenericcontrolhgchtmlimagehimghimgheaderhtmlinputbutton（按钮）hbbtnhbbtnbuttonhtmlinputbutton（重置）hrbtnhrbtnresethtmlinp

9、utbutton（提交）hcbtnhcbtnsubmithtmlinputcheckboxhickhickselectallhtmlinputfilehifilehifileuploadfilehtmlinputhiddenhihidhihiduseridhtmlinputimagehiimghiimguserupdatehtmlinputradiobuttonhirbhirbselectuserhtmlinputtext（密码）hipwdhipwduserpasshtmlinputtext（文本）hitxthitxtusernamehtmlselecthslthsltuserhtmltabl

10、ehtabhtabheaderhtmltablecellhtchtcusernamehtmltablerowhtrhtrtitlehtmltextareahtxtahtxtanotes4) 常量、变量名及类名命名规范a. 常量命名规则： 大写英文字母加下划线;.举例：price， market_priceb. 变量命名变量类型类型简写标准命名举例arrayarrarrshoppinglistbooleanblnblnispostbackbytebytbytpixelvaluecharchrchrdelimiterdatetimedtmdtmstartdatedecimaldecdecavera

11、geheightdoubledbldblsizeofuniverseguidguguuseridintegerintintrowcounterlonglnglngbillgatesincomeobjectobjobjreturnvalueshortshrshraveragesinglesngsngmaximumstringstrstrfirstnamec. 类命名1、类名命名： 以该类的具体用途命名该类类名，全英文构成， 单个单词首字母大写，组合单词每个单词首字母大写，其它字母小写， 例如： userinfo，productdetails 。2、顶级命名空间命名：例如：test。3、类库名空间

12、命名： “ test” +“ .”+类库名，例如：test.bll。4、类名空间命名： “ test”+“ .” +类库名 +类名，例如： test.model.deptinfo 。5) css 命名规范样式表文件名 命名规则，全英文构成，单个单词首字母大写，组合单词每个单词首字母大写，其它字母小写，并以“style”结尾，前面组合单词指明该样式表的用途，例如： homepagestyle，表示应用于主页的全局样式表；proudctliststyle ，表示应用于产品列表的样式表。a. css 常用命名规范头： header内容： content/container;.尾： footer导航：

13、 nav侧栏： sidebar栏目： column页面外围控制整体布局宽度：wrapper左右中： leftrightcenter登录条： loginbar标志： logo广告： banner页面主体： main热点： hot新闻： news下载： download子导航： subnav菜单： menu子菜单： submenu搜索： search友情链接： friendlink页脚： footer版权： copyright滚动： scroll内容： content标签页： tab文章列表： list提示信息： msg小技巧： tips栏目标题： title加入： joinus指南： guild

14、服务： service;.注册： regsiter状态： status投票： vote合作伙伴： partnerb. 注释的写法/*footer*/内容区/*endfooter*/c. id 的命名(1)页面结构容器 :container页头： header内容： content/container页面主体： main页尾： footer导航： nav侧栏： sidebar栏目： column页面外围控制整体布局宽度：wrapper左右中： leftrightcenter(2)导航导航： nav主导航： mainbav子导航： subnav顶导航： topnav边导航： sidebar左导航：

15、 leftsidebar右导航： rightsidebar菜单： menu;.子菜单： submenu标题 :title摘要 :summary(3)功能标志： logo广告： banner登陆： login登录条： loginbar注册： regsiter搜索： search功能区： shop标题： title加入： joinus状态： status按钮： btn滚动： scroll标签页： tab文章列表： list提示信息： msg当前的 :current小技巧： tips图标 :icon注释： note指南： guild服务： service热点： hot新闻： news下载： down

16、load投票： vote;.合作伙伴： partner友情链接： link版权： copyrightd. class 的命名(1)颜色：使用颜色的名称或者16 进制代码。如.redcolor:red;.f60color:#f60;.ff8600color:#ff8600;(2)字体大小，直接使用font+ 字体大小 作为名称。如.font12pxfont-size:12px;.font9ptfont-size:9pt;(3)对齐样式，使用对齐目标的英文名称。如.leftfloat:left;.bottomfloat:bottom;(4)标题栏样式，使用 类别 +功能 的方式命名。如.barne

17、ws.barproducte. 注意事项1.一律小写 ;2.尽量用英文；3.不加中杠和下划线；4.尽量不缩写，除非一看就明白的单词。主要的 masterstyle.css模块 modulestyle.css基本共用basestyle.css布局，版面layoutstyle.css主题 themesstyle.css专栏 columnsstyle.css文字 fontstyle.css表单 formsstyle.css;.补丁 mendstyle.css打印 printstyle.css4. 代码书写格式规范o文件之中不得存在无规则的空行，比如说连续十个空行。一般来讲函数与函数之间的空行为 2-

18、3行。o在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1-2 行。o每行长度尽量避免超过屏幕宽度，应不超过80 个字符。o使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将x=a*b/c*d写成 x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。o 避免采用过于复杂的条件测试。o 避免过多的循环嵌套和条件嵌套。o一个函数不要超过200行。一个文件应避免超过2000行。o 不可以使用 goto 语句。o避免采用多赋值语句，如x = y = z;。5. 代码注释规范1) .cs 文件的注释所有 .cs 文件开头都要加上注释，写明文件创建时间、作者、用途概述等例如：

19、/*/ 新增日期 :2004.7.19/ 作者 :xxx/ 內容说明 : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx /*2) 函数过程注释所 有 的 函 数 体 开 头 都 要 加 上 注 释 ， 所 以 注 释 使 用 .net注 释 规 范 。例如：;./ /构造函数/ / 示例参数1/ 示例参数2public upgradethread(string is_xxx1, string is_xxx2)/ 3) 常量变量注释所有的常量 量， 无 是全局 是局部使用的，凡是 代 整体起到关 性做用的都需要加上注 。例如：/ / 当前 程指向的 份文件本地保存路径/ p

20、ublic string strstorepath= ;4) 代码修改注释当开 者 以前的程序代 ，需要在修改 的开始及 尾，加上自己的注 信息。例如：/begin 2004-7-19 jayson修正了 xxx问题略/end 2004-7-19 jayson注 量化 准：注 占代 量的10%及以上;.附录一： .net中的命名规范名称空间的命名命名名称空间的一般规则如下：companyname.technologyname这样，我们看到的名称空间应该是这样的：microsoft.officepowersoft.powerbuilder注意：这只是一个原则。第三方公司可以选择其它的名字。避免用

21、公司名称或其它著名品牌的名称作为名称空间的前缀， 这样会造成两个公布的名称空间有同一个名称的可能性。例如： 将微软提供的office自动类命名为microsoft.office使用 pascal大写方式，用逗号分隔逻辑成分。例如： microsoft.office.powerpoint如果你的品牌使用的是非传统大写方式， 那么一定要遵循你的品牌所确定使用的大写方式，即使这种方式背离了通常的名称空间大写规则。例如： next.webobjectsee.cummings类和类成分的命名类的命名原则是用名词或名词短语命名类，使用pascal大写。减少类名中缩写的使用量。不要使用任何类前缀（比如c），

22、不要使用带下划线的字符。例如： public class filestream public class button public class string 变量的命名名称中各单词首字母均为大写。例如： findlastrecordredrawmyform在内部范围中避免使用与外部范围中的名称相同的名称。若访问错误变量， 则会产生错误结果。若变量与同一名称的关键字冲突，则必须在关键字前加适当的类型库以作标识。例如： 若有一个名为date的变量，只能通过调用system.date来使用内部 date函数。函数和方法的命名;.函数和方法的命名应该以动词开始，使用pascal大写。不要使用带下划线的字符。例如： initnamearrayclosedialog接口命名原则使用名词或名词短语，或者描述行为的形容词来命名接口,使用 pascal大写。减少接口名中缩写的使用量，在接口名前加前缀i ，以表示这个类型是一个接口。例如：icomponent（描述性名词）icustomattributeprovider（名词短语）ipersistable（形容词）参数的命名使用描述性参数名。参数名应该具有足够的描述性，这样在大多数情况下参数名和它的种类可以用来确定它的意思。根据参数的意思来命名参数，而不是根据参数的种类来命名。我们希望开发工具可以用很方便的方式提供关于参数种类的信息，这样参数名可