文档介绍：2015年12月
Java开发规范培训
培训纲要
前言概述
1
WEB规范
2
Java规范
3
数据库规范
4
5
基本概念
开发规范
在软件开发过程中,为了让开发人员间便于交流和协作,并起到“指导开发”和“规范开发”作用的条文。从软件工程的项目生命周期而言,开发过程主要涉及设计和编码两个过程域。
编码规范
系统编码过程中,项目工程所涉及到的文件内容编辑的代码规则。
范围定义
开发规范
开发规范涉及范围较广,编码规范最为核心。除此之外的规范有:设计规范、开发环境、部署环境、内部软件平台或软件成品使用以及项目管理涉及的相关规约。
编码规范
针对公司主要是WEB项目的特点,编码规范涉及的范围有:WEB规范、Java规范、数据库规范
WEB规范
目录结构
命名
注释
UI
代码
目录结构
根目录有images、script、style、WEB-INF四个目录以外,可创建如:platform(业务平台)、skyflow(工作流)公司复用产品文件夹等。(执行)
根目录中可创建项目应用目录,应用目录下可逐级创建子系统、功能模块的文件夹,最好不要超过3层。(建议)
根目录中,项目组研发人员对项目应用目录有权限修改,其他目录不允许修改。(执行)
项目应用目录下的子系统、功能模块目录不能让研发人员随意修改,由项目经理或分配专人统一设计。(建议)
命名规范
文件夹
英文或中文首字母来表达目录的“作用”或“功能”,推荐采用英文较为规范。(建议)
文件
除特定的页面之外,,一般采用“作用”或“功能”+“名词”和“作用”或“功能”+“动词”;也可以在两者之间添加下划线“_”。(建议)
文件命名与目录一样,统一使用小写字母。如:。如不使用下划线,单词连接首字母要大写,如:(执行)
命名规范
标签、样式(待补充)
脚本
“方法”命名采用“动词”或“动宾”结构,多个单词之间可添加下划线“_”或单词连接首字母要大写;脚本命名统一使用小写字母。举例来说,“动词”命名,如:trim(str)、save();“动宾”结构命名,如:send_mail()、openPage()、isNumber()(执行)
“内部变量与参数”命名采用“名字”来命名。多个单词之间可添加下划线“_”或单词连接首字母要大写。举例:var windowWidth; var file_size(执行)
注释规范
文件
文件代码顶部必须存在一个基本描述注释,包含文件名、功能描述、参数列表和历史修改信息。(执行)
Jsp文件的HTML代码中,如需添加HTML注释的,自行定义注释格式,简洁就好。HTML注释:(建议)
脚本
方法注释在方法体头部添加注释说明,主要描述脚本方法的功能和参数。(执行)
变量注释在方法体内部定义变量时进行说明,临时变量可不注释。(建议)
脚本块注释在脚本方法体内部存在if-else、循环语句和特定的功能代码块需要增加注释。(执行)