SlideShare a Scribd company logo
1 of 7
希望科技研发部变量命名及编码规范
                                                                                        创建日期:2009-6-1
                                                                                          创建人:王洪剑
                                                                                      最后修改时间:2010-1-26
                                                                                          最后修改人:王洪剑

一、命名规则
==================================================================
1.Camel 变量命名法 --userId
2.Pascal 变量命名法 --UserId
3.匈牙利变量合法法 –strUserId

1):变量 Camel 变量命名 userId 业务逻辑对象 bllNews 实体 objNewsClass
2):循环变量:for(int i=0;i<n;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="int">pageIndex</param>
                                                   ///             <returns            type="string"></returns>
3       )        :        模         块       内          部       重        要         代       码        注        释
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="delValue">0:已删除 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”]);
     Hope_T_NewsManager…..
}
protected void DelNews()
{
       int intNewsId=Convert.ToInt32(request.querystring[“news_id”]);
       Hope_T_NewsManager…..
}


改进:
private int intNewsId
{
      get
{
            int id= Convert.ToInt32(request.querystring[“news_id”].ToString().Replace(“’”,””));
            return id;
}
}
3):如果不传递参数会报错的页面要做出错处理
protected void Page_Load()
{
      if(request.querystring[“news_id]==null)
      response.redirect(“news_list.aspx”);
else
      ….
}
4):无数据时要做空数据判断
if(listNews.count>0)
{

}
else
  return “抱歉,暂无数据……”;
5):使用 StringBuilder 方法,使用换行:
  sb.Append(“<ul>n”);
  sb.Append(“       <li>” + listNews.NewsTitle + “</li>n”);
  sb.Append(“</ul>n”);
6):null 判断:可能存在 null 列的要做是否为 null 判断
7):Page.ClientScript.RegisterStartupScript(typeof(string), "Failure", "alert("仅可上传”);", true);


四、交互方式
1):确认删除:“此操作将删除当前记录,是否继续?”;(添加确认:“是否确认添加?”)
2):必填字段后加 * 号,放在文本框前面,文字后面
3):文字标签不加冒号;
4):分页文字:

五:常用数据字典
1):密码找回问题:
你的出生地?
   你的职业?
   你父亲的名字?
   你高中班主任老师的名字?
   你最喜欢的一部电影的名字?
   你最喜欢的一首歌曲的名字?
   你最喜欢的明星?
常用正则表达式
固定电话号码:(d{3}-d{8})|(d{4}-d{7,8})
手机号码:1[3,5,8]d{9}
4 到 64 个文字:.{4,64}
短日期:d{4}-d{2}-d{2}

六:颜色说明
表示未完成、未通过之类否定的文字使用红色文字(#ff0000);
表示已完成、已通过之类肯定的文字使用绿色文字(#008000);
表示正在进行中的文字使用蓝色(#0000ff)
如:未通过  已通过 待处理

七:样式
文字表现形式:




1、添加、删除、修改、查看 首页 上一页 下一页 尾页 第 1/8 页 当前第 1页,共 8页
其中,只有一页时页码下拉框表现为“第 1/1 页”;
当页码为 0 时,首页、尾页均有链接
其中合理使用单选按钮或多选按钮,底部文字为“选定处理”;
2、无数据时显示“抱歉,暂无数据……”;




3、当页面初加载时需对空数据 GridVew 设置
3、按钮文字:
  添加时:确认添加、取消返回




  修改时:确认修改、取消返回




4、tab 下均要有导航文字说明




5、表格左侧文字与右侧文字




6、必填信息后要使用红色*号标记
7、需要说明的地方加说明提示性文字
<span class=”remInfo”>1 到 64 个文字</span>
均要加正则验证




8、查询类界面
两个 table 之间要有 10px 的间隔,一般是在第一个 table 里加 style=”margin-bottom:10px;”

More Related Content

What's hot

Kissy简介
Kissy简介Kissy简介
Kissy简介jay li
 
Lucene2 4学习笔记1
Lucene2 4学习笔记1Lucene2 4学习笔记1
Lucene2 4学习笔记1yiditushe
 
Spring 2.x 中文
Spring 2.x 中文Spring 2.x 中文
Spring 2.x 中文Guo Albert
 
Mongo db技术分享
Mongo db技术分享Mongo db技术分享
Mongo db技术分享晓锋 陈
 
Sql语句的优化
Sql语句的优化Sql语句的优化
Sql语句的优化abszhanghe
 
Jni攻略之八――操作对象的构造方法
Jni攻略之八――操作对象的构造方法Jni攻略之八――操作对象的构造方法
Jni攻略之八――操作对象的构造方法yiditushe
 
流行应用的加密算法实现缺陷与利用
流行应用的加密算法实现缺陷与利用流行应用的加密算法实现缺陷与利用
流行应用的加密算法实现缺陷与利用ph4nt0m
 
第十期 阿甘Javascript开发思想(入门篇)
第十期 阿甘Javascript开发思想(入门篇)第十期 阿甘Javascript开发思想(入门篇)
第十期 阿甘Javascript开发思想(入门篇)9scss
 
Mongo db技术交流
Mongo db技术交流Mongo db技术交流
Mongo db技术交流liuts
 
PHP Coding Standard and 50+ Programming Skills
PHP Coding Standard and 50+ Programming SkillsPHP Coding Standard and 50+ Programming Skills
PHP Coding Standard and 50+ Programming SkillsHo Kim
 
Javascript之昨是今非
Javascript之昨是今非Javascript之昨是今非
Javascript之昨是今非Tony Deng
 
Clean code_1_Nameing
Clean code_1_NameingClean code_1_Nameing
Clean code_1_NameingChiaChun Liu
 
用Jquery实现拖拽层
用Jquery实现拖拽层用Jquery实现拖拽层
用Jquery实现拖拽层yiditushe
 
NHibernate分享(1) share
NHibernate分享(1) shareNHibernate分享(1) share
NHibernate分享(1) shareXu Huang
 
Moodle 项目帮助手册:程序编写准则
Moodle 项目帮助手册:程序编写准则Moodle 项目帮助手册:程序编写准则
Moodle 项目帮助手册:程序编写准则YUCHENG HU
 
程式人雜誌 2015年五月
程式人雜誌 2015年五月程式人雜誌 2015年五月
程式人雜誌 2015年五月鍾誠 陳鍾誠
 
第六章解答
第六章解答第六章解答
第六章解答jiannrong
 

What's hot (20)

Kissy简介
Kissy简介Kissy简介
Kissy简介
 
Lucene2 4学习笔记1
Lucene2 4学习笔记1Lucene2 4学习笔记1
Lucene2 4学习笔记1
 
Spring 2.x 中文
Spring 2.x 中文Spring 2.x 中文
Spring 2.x 中文
 
Qwrap jss
Qwrap jssQwrap jss
Qwrap jss
 
Mongo db技术分享
Mongo db技术分享Mongo db技术分享
Mongo db技术分享
 
Sql语句的优化
Sql语句的优化Sql语句的优化
Sql语句的优化
 
Jni攻略之八――操作对象的构造方法
Jni攻略之八――操作对象的构造方法Jni攻略之八――操作对象的构造方法
Jni攻略之八――操作对象的构造方法
 
流行应用的加密算法实现缺陷与利用
流行应用的加密算法实现缺陷与利用流行应用的加密算法实现缺陷与利用
流行应用的加密算法实现缺陷与利用
 
第十期 阿甘Javascript开发思想(入门篇)
第十期 阿甘Javascript开发思想(入门篇)第十期 阿甘Javascript开发思想(入门篇)
第十期 阿甘Javascript开发思想(入门篇)
 
Mongo db技术交流
Mongo db技术交流Mongo db技术交流
Mongo db技术交流
 
PHP Coding Standard and 50+ Programming Skills
PHP Coding Standard and 50+ Programming SkillsPHP Coding Standard and 50+ Programming Skills
PHP Coding Standard and 50+ Programming Skills
 
JS2
JS2JS2
JS2
 
Jasmine2
Jasmine2Jasmine2
Jasmine2
 
Javascript之昨是今非
Javascript之昨是今非Javascript之昨是今非
Javascript之昨是今非
 
Clean code_1_Nameing
Clean code_1_NameingClean code_1_Nameing
Clean code_1_Nameing
 
用Jquery实现拖拽层
用Jquery实现拖拽层用Jquery实现拖拽层
用Jquery实现拖拽层
 
NHibernate分享(1) share
NHibernate分享(1) shareNHibernate分享(1) share
NHibernate分享(1) share
 
Moodle 项目帮助手册:程序编写准则
Moodle 项目帮助手册:程序编写准则Moodle 项目帮助手册:程序编写准则
Moodle 项目帮助手册:程序编写准则
 
程式人雜誌 2015年五月
程式人雜誌 2015年五月程式人雜誌 2015年五月
程式人雜誌 2015年五月
 
第六章解答
第六章解答第六章解答
第六章解答
 

Viewers also liked

Selenium-Browser-Based-Automated-Testing-for-Grails-Apps
Selenium-Browser-Based-Automated-Testing-for-Grails-AppsSelenium-Browser-Based-Automated-Testing-for-Grails-Apps
Selenium-Browser-Based-Automated-Testing-for-Grails-Appschrisb206 chrisb206
 
Mobile applications Wapalta & AltaWidgets
Mobile applications Wapalta & AltaWidgetsMobile applications Wapalta & AltaWidgets
Mobile applications Wapalta & AltaWidgetsElenaRodionova
 
Presentació exposició EL JOC
Presentació exposició EL JOCPresentació exposició EL JOC
Presentació exposició EL JOCguestb78cc1
 
Tunisia Internet Governance
Tunisia Internet GovernanceTunisia Internet Governance
Tunisia Internet Governancerafikd
 
The Six Highest Performing B2B Blog Post Formats
The Six Highest Performing B2B Blog Post FormatsThe Six Highest Performing B2B Blog Post Formats
The Six Highest Performing B2B Blog Post FormatsBarry Feldman
 
The Outcome Economy
The Outcome EconomyThe Outcome Economy
The Outcome EconomyHelge Tennø
 

Viewers also liked (9)

Wapalta December 2009
Wapalta December 2009Wapalta December 2009
Wapalta December 2009
 
Los Gatos
Los GatosLos Gatos
Los Gatos
 
Selenium-Browser-Based-Automated-Testing-for-Grails-Apps
Selenium-Browser-Based-Automated-Testing-for-Grails-AppsSelenium-Browser-Based-Automated-Testing-for-Grails-Apps
Selenium-Browser-Based-Automated-Testing-for-Grails-Apps
 
Mobile applications Wapalta & AltaWidgets
Mobile applications Wapalta & AltaWidgetsMobile applications Wapalta & AltaWidgets
Mobile applications Wapalta & AltaWidgets
 
Presentació exposició EL JOC
Presentació exposició EL JOCPresentació exposició EL JOC
Presentació exposició EL JOC
 
Diaporama
DiaporamaDiaporama
Diaporama
 
Tunisia Internet Governance
Tunisia Internet GovernanceTunisia Internet Governance
Tunisia Internet Governance
 
The Six Highest Performing B2B Blog Post Formats
The Six Highest Performing B2B Blog Post FormatsThe Six Highest Performing B2B Blog Post Formats
The Six Highest Performing B2B Blog Post Formats
 
The Outcome Economy
The Outcome EconomyThe Outcome Economy
The Outcome Economy
 

Similar to 希望科技研发部变量命名及编码规范

Flex 4.5 action custom component development
Flex 4.5 action custom component developmentFlex 4.5 action custom component development
Flex 4.5 action custom component developmentjexchan
 
张所勇:前端开发工具推荐
张所勇:前端开发工具推荐张所勇:前端开发工具推荐
张所勇:前端开发工具推荐zhangsuoyong
 
开源应用日志收集系统
开源应用日志收集系统开源应用日志收集系统
开源应用日志收集系统klandor
 
Django development
Django developmentDjango development
Django developmentloveyudu
 
淘宝开放产品前端实践
淘宝开放产品前端实践淘宝开放产品前端实践
淘宝开放产品前端实践taobao.com
 
Struts学习笔记
Struts学习笔记Struts学习笔记
Struts学习笔记yiditushe
 
Google protocol buffers简析
Google protocol buffers简析Google protocol buffers简析
Google protocol buffers简析wavefly
 
旺铺前端设计和实现
旺铺前端设计和实现旺铺前端设计和实现
旺铺前端设计和实现hua qiu
 
J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架wtxidian
 
Free Marker中文文档
Free Marker中文文档Free Marker中文文档
Free Marker中文文档yiditushe
 
J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架fangdeng
 
前端MVVM框架安全
前端MVVM框架安全前端MVVM框架安全
前端MVVM框架安全Borg Han
 
Kindeditor设计思路v2
Kindeditor设计思路v2Kindeditor设计思路v2
Kindeditor设计思路v2luolonghao
 
技术交流 支付二代信息安全及其代收付实现
技术交流 支付二代信息安全及其代收付实现技术交流 支付二代信息安全及其代收付实现
技术交流 支付二代信息安全及其代收付实现Banned Li
 
JavaScript Advanced Skill
JavaScript Advanced SkillJavaScript Advanced Skill
JavaScript Advanced Skillfirestoke
 
Php应用程序常见安全问题解析
Php应用程序常见安全问题解析Php应用程序常见安全问题解析
Php应用程序常见安全问题解析mysqlops
 
CKAN 技術介紹 (開發篇)
CKAN 技術介紹 (開發篇)CKAN 技術介紹 (開發篇)
CKAN 技術介紹 (開發篇)Chengjen Lee
 

Similar to 希望科技研发部变量命名及编码规范 (20)

Flex 4.5 action custom component development
Flex 4.5 action custom component developmentFlex 4.5 action custom component development
Flex 4.5 action custom component development
 
张所勇:前端开发工具推荐
张所勇:前端开发工具推荐张所勇:前端开发工具推荐
张所勇:前端开发工具推荐
 
开源应用日志收集系统
开源应用日志收集系统开源应用日志收集系统
开源应用日志收集系统
 
Structs2簡介
Structs2簡介 Structs2簡介
Structs2簡介
 
Django development
Django developmentDjango development
Django development
 
淘宝开放产品前端实践
淘宝开放产品前端实践淘宝开放产品前端实践
淘宝开放产品前端实践
 
Struts学习笔记
Struts学习笔记Struts学习笔记
Struts学习笔记
 
Google protocol buffers简析
Google protocol buffers简析Google protocol buffers简析
Google protocol buffers简析
 
旺铺前端设计和实现
旺铺前端设计和实现旺铺前端设计和实现
旺铺前端设计和实现
 
J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架
 
Free Marker中文文档
Free Marker中文文档Free Marker中文文档
Free Marker中文文档
 
J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架J engine -构建高性能、可监控的前端应用框架
J engine -构建高性能、可监控的前端应用框架
 
前端MVVM框架安全
前端MVVM框架安全前端MVVM框架安全
前端MVVM框架安全
 
Kindeditor设计思路v2
Kindeditor设计思路v2Kindeditor设计思路v2
Kindeditor设计思路v2
 
技术交流 支付二代信息安全及其代收付实现
技术交流 支付二代信息安全及其代收付实现技术交流 支付二代信息安全及其代收付实现
技术交流 支付二代信息安全及其代收付实现
 
JavaScript Advanced Skill
JavaScript Advanced SkillJavaScript Advanced Skill
JavaScript Advanced Skill
 
Js dom
Js domJs dom
Js dom
 
Glider
GliderGlider
Glider
 
Php应用程序常见安全问题解析
Php应用程序常见安全问题解析Php应用程序常见安全问题解析
Php应用程序常见安全问题解析
 
CKAN 技術介紹 (開發篇)
CKAN 技術介紹 (開發篇)CKAN 技術介紹 (開發篇)
CKAN 技術介紹 (開發篇)
 

希望科技研发部变量命名及编码规范

  • 1. 希望科技研发部变量命名及编码规范 创建日期:2009-6-1 创建人:王洪剑 最后修改时间:2010-1-26 最后修改人:王洪剑 一、命名规则 ================================================================== 1.Camel 变量命名法 --userId 2.Pascal 变量命名法 --UserId 3.匈牙利变量合法法 –strUserId 1):变量 Camel 变量命名 userId 业务逻辑对象 bllNews 实体 objNewsClass 2):循环变量:for(int i=0;i<n;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="int">pageIndex</param> /// <returns type="string"></returns> 3 ) : 模 块 内 部 重 要 代 码 注 释
  • 2. 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="delValue">0:已删除 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”]); Hope_T_NewsManager….. } protected void DelNews()
  • 3. { int intNewsId=Convert.ToInt32(request.querystring[“news_id”]); Hope_T_NewsManager….. } 改进: private int intNewsId { get { int id= Convert.ToInt32(request.querystring[“news_id”].ToString().Replace(“’”,””)); return id; } } 3):如果不传递参数会报错的页面要做出错处理 protected void Page_Load() { if(request.querystring[“news_id]==null) response.redirect(“news_list.aspx”); else …. } 4):无数据时要做空数据判断 if(listNews.count>0) { } else return “抱歉,暂无数据……”; 5):使用 StringBuilder 方法,使用换行: sb.Append(“<ul>n”); sb.Append(“ <li>” + listNews.NewsTitle + “</li>n”); sb.Append(“</ul>n”); 6):null 判断:可能存在 null 列的要做是否为 null 判断 7):Page.ClientScript.RegisterStartupScript(typeof(string), "Failure", "alert("仅可上传”);", true); 四、交互方式 1):确认删除:“此操作将删除当前记录,是否继续?”;(添加确认:“是否确认添加?”) 2):必填字段后加 * 号,放在文本框前面,文字后面 3):文字标签不加冒号; 4):分页文字: 五:常用数据字典 1):密码找回问题:
  • 4. 你的出生地? 你的职业? 你父亲的名字? 你高中班主任老师的名字? 你最喜欢的一部电影的名字? 你最喜欢的一首歌曲的名字? 你最喜欢的明星? 常用正则表达式 固定电话号码:(d{3}-d{8})|(d{4}-d{7,8}) 手机号码:1[3,5,8]d{9} 4 到 64 个文字:.{4,64} 短日期:d{4}-d{2}-d{2} 六:颜色说明 表示未完成、未通过之类否定的文字使用红色文字(#ff0000); 表示已完成、已通过之类肯定的文字使用绿色文字(#008000); 表示正在进行中的文字使用蓝色(#0000ff) 如:未通过 已通过 待处理 七:样式 文字表现形式: 1、添加、删除、修改、查看 首页 上一页 下一页 尾页 第 1/8 页 当前第 1页,共 8页 其中,只有一页时页码下拉框表现为“第 1/1 页”; 当页码为 0 时,首页、尾页均有链接 其中合理使用单选按钮或多选按钮,底部文字为“选定处理”; 2、无数据时显示“抱歉,暂无数据……”; 3、当页面初加载时需对空数据 GridVew 设置
  • 5. 3、按钮文字: 添加时:确认添加、取消返回 修改时:确认修改、取消返回 4、tab 下均要有导航文字说明 5、表格左侧文字与右侧文字 6、必填信息后要使用红色*号标记
  • 6. 7、需要说明的地方加说明提示性文字 <span class=”remInfo”>1 到 64 个文字</span> 均要加正则验证 8、查询类界面
  • 7. 两个 table 之间要有 10px 的间隔,一般是在第一个 table 里加 style=”margin-bottom:10px;”