《C#代码开发命名规范示例》由会员分享,可在线阅读,更多相关《C#代码开发命名规范示例(14页珍藏版)》请在金锄头文库上搜索。
1、代码开发命名规范拟稿该规范的制定致力于规范代码格式,提高开发效率,保证程序质量,最终解释权归*软件开发组。1. 项目名称及类库命名规范项目名称:Testlatform,简写Test实体类类库命名:Test.Model业务逻辑类类库命名:Test.BLL数据工厂类类库命名:Test.DALFactory数据库帮助类类库命名:Test.DBUtility数据接口类类库命名:Test.IDAL数据访问层类类库命名:Test.SQLServerDAL常用帮助类类库命名:Test.Utils表现层类库命名:Test.UI2. 数据库名称及字段命名规范1) 数据库命名数据库命名:同项目名称简写(Test)
2、2) 实体(表)命名规则:前缀_表存储内容简称举例:Sys_User 【系统用户表】Sys_Role【角色表】3) 属性(列)命名规则:前缀+列存储内容简称举例:UserID【用户编号】UserIDRoleName【角色名称】4) 视图命名:规则:视图以V作为前缀,其他命名规则和表的命名类似;命名应尽量体现各视图的功能。举例:V_GetUserLogInfo【获取用户的登录信息】5) 触发器的命名规则:触发器以TR作为前缀,触发器名为相应的表名加上后缀,Insert触发器加_I,Delete触发器加_D,Update触发器加_U, 举例:TR_User_I【添加用户时激发】6) 存储过程命名规
3、则:存储过程应以UP_开头,和系统的存储过程区分,后续部分以存储过程内容加存储过程的动作构成(参考动软代码生成器生成存储过程的规则),并用下划线分割各个组成部分。举例:UP_Sys_User_Update【更新系统用户信息】7) 变量命名规则:变量名采用小写,若属于词组形式,用下划线分隔每个单词,举例:my_err_no。8) 命名中其他注意事项a. 以上命名都不得超过30个字符的系统限制。变量名的长度限制为29(不包括标识字符)。b. 数据对象、变量的命名都采用英文字符,禁止使用中文命名。绝对不要在对象名的字符之间留空格。c. 小心保留词,要保证你的字段名没有和保留词、数据库系统或者常用访问
4、方法冲突d. 保持字段名和类型的一致性,在命名字段并为其指定数据类型的时候一定要保证一致性。假如数据类型在一个表里是整数,那在另一个表里可就别变成字符型了。3. 项目代码命名规范1) ADO.NET 命名规范注释:动软代码生成器生成的逻辑代码除外。数据类型数据类型简写标准命名举例ConnectionconconNorthwindCommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdstdstNorthWindDataTabledt
5、bldtblProductDataRowdrowdrowRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts2) WebControl 命名规范Web控件名简写标准命名举例AdRotatoradrtadrtExampleButtonbtnbtnSubmitCalendarcalcalMettingDatesCheckBoxchkchkBlueCheckBoxListchklchklFavColorsCompareValidatorvalcvalcValidAg
6、eCustomValidatorvalxvalxDBCheckDataGriddgrddgrdTitlesDataListdlstdlstTitlesDropDownListdropdropCountriesHyperLinklnklnkDetailsImageimgimgAuntBettyImageButtonibtnibtnSubmitLabellbllblResultsLinkButtonlbtnlbtnSubmitListBoxlstlstCountriesPanelpnlpnlForm2PlaceHolderplhplhFormContentsRadioButtonradradFem
7、aleRadioButtonListradlradlGenderRangeValidatorvalgvalgAgeRegularExpressionvalevaleEmail_ValidatorRepeaterrptrptQueryResultsRequiredFieldValidatorvalrvalrFirstNameTabletbltblCountryCodesTableCelltblctblcGermanyTableRowtblrtblrCountryTextBoxtxttxtFirstNameValidationSummaryvalsvalsFormErrorsXMLxmlcxmlc
8、TransformResults3) HTML控件命名规则HTML控件名简写标准命名举例HtmlAnchorhahhahUserDetialHtmlButtonhbtnhbtnConfirm HtmlFormhformhformFromUserHtmlGenericControlhgcHtmlImagehimghimgHeaderHtmlInputButton(按钮)hbbtnhbbtnButtonHtmlInputButton(重置)hrbtnhrbtnResetHtmlInputButton(提交)hcbtnhcbtnSubmit HtmlInputCheckBoxhickhickSele
9、ctAllHtmlInputFilehifilehifileUploadFileHtmlInputHiddenhihidhihidUserIDHtmlInputImagehiimghiimgUserUpdateHtmlInputRadioButtonhirbhirbSelectUserHtmlInputText(密码)hipwdhipwdUserPassHtmlInputText(文本)hitxthitxtUserNameHtmlSelecthslthsltUserHtmlTablehtabhtabHeaderHtmlTableCellhtchtcUserNameHtmlTableRowhtr
10、htrTitleHtmlTextAreahtxtahtxtaNotes4) 常量、变量名及类名命名规范a. 常量命名规则:大写英文字母加下划线举例:PRICE,MARKET_PRICEb. 变量命名变量类型类型简写标准命名举例ArrayarrarrShoppingList Boolean blnblnIsPostBackBytebytbytPixelValue CharchrchrDelimiterDateTime dtmdtmStartDateDecimaldecdecAverageHeight DoubledbldblSizeofUniverse GuidguguUserIDInteger
11、intintRowCounter Long lng lngBillGatesIncome Object obj objReturnValue Short shr shrAverage Single sng sngMaximum String str strFirstName c. 类命名1、类名命名:以该类的具体用途命名该类类名,全英文构成,单个单词首字母大写,组合单词每个单词首字母大写,其它字母小写,例如:UserInfo,ProductDetails。2、顶级命名空间命名:例如:Test。3、类库名空间命名:“Test”+“.”+类库名,例如:Test.BLL。4、 类名空间命名:“Tes
12、t”+“.”+类库名+类名,例如:Test.Model.DeptInfo。5) CSS命名规范样式表文件名 命名规则,全英文构成,单个单词首字母大写,组合单词每个单词首字母大写,其它字母小写,并以“Style”结尾,前面组合单词指明该样式表的用途,例如:HomePageStyle,表示应用于主页的全局样式表;ProudctListStyle,表示应用于产品列表的样式表。a. CSS常用命名规范头:header内容:content/container尾:footer导航:nav侧栏:sidebar栏目:column页面外围控制整体布局宽度:wrapper左右中:leftrightcenter登录
13、条:loginbar标志:logo广告:banner页面主体:main热点:hot新闻:news下载:download子导航:subnav菜单:menu子菜单:submenu搜索:search友情链接:friendlink页脚:footer版权:copyright滚动:scroll内容:content标签页:tab文章列表:list提示信息:msg小技巧:tips栏目标题:title加入:joinus指南:guild服务: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左导航:leftsidebar右导航:rightsidebar菜单:menu子菜单:submenu标题:title摘要:summary(3)功能标志:logo广告:banner登陆:login登录条:loginbar注册:re