研发规范概要介绍.pptx

大洋新媒体融合研发规范2016.06.30开发工具以及软件发布管理源码规范源码库管理规范日志文件规范版本号规范发布规范服务开发规范规范检查提纲开发工具 BS开发推荐使用Eclipse或者MyEclipse Android开发推荐使用Android StudioJDK版本以及Tomcat版本 JDK: jdk-7u79；Tomcat： apache-tomcat-7.0.69前端开发 PC端：metronic；移动端：AmazeUI后端开发架构 SpringMVC+Spring+Mybatis软件发布 采用maven进行工程的管理以及war包的发布开发工具以及软件发布开发工具以及软件发布管理源码规范源码库管理规范日志文件规范版本号规范发布规范服务开发规范规范检查提纲代码的组织结构规范代码书写规范SQL语句规范日志记录规范源码规范参考maven的组织结构源码规范--代码组织结构代码的组织结构规范代码书写规范SQL语句规范日志记录规范源码规范代码的格式化 命名意义化注释规范化其他一些建议源码规范--代码书写规范每个页面、每个类中的代码都需要格式化，一般IDE都有该功能。【***】去掉无用的代码和文件html中标签需要配对，标签为小写。比较复杂的界面时，需要标记标签的起始以及结束js语句需要以分号结尾，变量使用必须要申明。申明对象用{}，申明数组用[]在含有混合操作符表达式中尽量使用括号，以防止操作符优先级不同带来的问题代码书写规范—代码格式化代码的格式化 命名意义化注释规范化其他一些建议源码规范--代码书写规范 命名一定要有意义，名称能真实的反映模块的功能特性。尽量少用缩略词，即使使用也应该是正确的英文单词缩写或者是大家约定俗成的缩写，不要自己生造缩略词。代码书写规范—命名意义化Java代码常见的一些命名规则：包名为全小写，如com.dayang.mpp类名的首单词的首字母为大写，如MainFrame方法名的首单词的首字母为小写，即小驼峰式，以动词开头。如getFirstName()常量以及枚举值为全大写，单词之间以下划线分割。如 int INTERNAL_TIME=2000变量的首单词的首字母为小写。如： String userName = “ABC”;接口名的开头建议加上字母‘I’前缀。如IRunable 。命名意义化—Java代码前端JS和CSS的一些命名规则：HTML的标签的id是标识某个具体模块，命名必须具体且唯一。如#db-video-list、#group-member-list等。class是用来标识某一类型的对象，命名简洁表意清楚。如：.list图片、css等的文件名为小写单词，如果出现多个单词，单词之间以-为分割符。如bootstrap-responsive.min.css，glyphicons-halflings-white.png，jquery-1.9.1.min.js等。HTML 、JSP文件的文件名以下划线作为单词的分隔符mashup_client.jsp。CSS中的样式以小写单词命名，如果出现多个单词，单词之间以-为分隔符。如： .prepend-top { margin-top:1.5em; }js文件中的方法名的命名规则和java中的方法的命名规则一致js中私有的变量以_为前缀，如_current, _defaultConfig等命名意义化—前端代码代码的格式化 命名意义化注释规范化其他一些建议源码规范--代码书写规范注释要正确。使程序看起来更清晰，更容易理解。注释要保持一致性，程序的逻辑修改对应的注释也必须修改程序重要的逻辑变更时，需要加注释，至少包括原逻辑，修改后的逻辑，以及修改人和时间。/** * MessageDispatcher的主要功能是将消息源传来的各种消息，分发给相应的消息 * 处理器进行处理。 * @author张三 * @version 2003/04/20 * @see UFMessage, Event * @deprecated 从NC-1.0 版之后该类的功能被EventDealer取代，但为了保持 * 向下兼容性，此类仍然被保留 */ // 李四 2003/05/21 // 添加了对帮助信息的处理函数sendToHelpManager(UFMessage msg)。// 王小二 2003/06/02// 修改了不能正确定位用户消息的错误。代码书写规范—注释规范化尽量不要有重复性的代码出现，能抽象公用的尽量抽取（DRY）业务逻辑的js文件最好是自闭包的，拥有自己的命名空间。 var FormValidation1 = function () { var handleValidation1 = function () { }; //内部函数 return { //对外