.net开发变量命名及编码规范.docVIP

研发部变量命名及编码规范(/) 一、命名规则 ================================================================== 1.Camel变量命名法 --userId 2.Pascal变量命名法 --UserId 3.匈牙利变量合法法 –strUserId 1）：变量 Camel变量命名 userId 业务逻辑对象bllNews 实体 objNewsClass 2）：循环变量：for(int i=0;in;i++); 3）：控件命名：如，chkSel,btnAdd,grdProduct,rptNews,txtTitle,lblName,lnkProduct… 4）：方法、函数如：protect void AddNews() ，避免使用displyNews,避免使用有歧义有冲突的名称，如DataBind()；DelUserById BindData 5）：html控件命名：input(text radio check submit reset button file hidden) 命名：txtTitle,radSel,chkSel,sumbitAdd,rst,btn,file,hdn 6）：文件命名：news_list,news_add,news_edit,news_info（避免使用dispay，look，detail） news_class_list,news_class_add,news_class_edit,news_class_info 母版页不能与普通文件命名重复，（避免命名空间重复） 7）：文件夹命名：images(icon),css,js,include,upload,database（备用：resource,bak,common,fla） 8）：传递参数命名：news_class_id,news_id,product_class_id,page,action,type 二、注释 1）：文件头（作者注释） //************************************************** //功能：客户类型选择（公共窗体） // //开发：王俊 //日期：2009-8-23 //最后修改日期：2009-8-23 //修改详情：2009-9-11 王洪剑 修正部分注释格式 //************************************************** 2）：模块功能头部注释 /// summary /// 分页显示数据 /// /summary /// param name=pageIndex type=intpageIndex/param /// returns type=string/returns3）：模块内部重要代码注释 if (list.Product_Passed == 1) { sb.Append(span class=\greenInfo\已通过/span); }//判断是否通过 else 4）：自动生成代码与个人手写代码块注释 #region 王洪剑 /// summary /// 方法：根据loanId删除对象 /// 开发：王洪剑 /// 日期：-9-11 /// 最后修改日期：-9-11 /// /summary /// param name=loanId贷款编号/param /// param name=delValue0:已删除1:未删除/param protected void DelLoanById(int loanId,string delValue) { } #endregion 5）：同一方法内不同作用的代码隔一行 三、代码书写 1）：不规范 if(news_passed==”1”) { lblTitle=”通过”; } else { lblTitle=”不通过”; } 改进后： lblTitle=(news_passed==”1”)?”通过”:”不通过”; 2）：当前文件公共变量，采用私有对象方式 protected void grdNewsBind() { int intNewsId=Convert.ToInt32(request.querystring[“news_id”]);