iB2Team项目开发规范

By KevinLee 2016-4-20
仅供参考

1. 目的

为了使软件开发过程顺畅，保证软件质量，于是有了这份开发规范文档。

2. 概述

项目以功能模块来划分分工
数据库不能随意修改，本地数据库须统一
有标准的Java代码风格，有良好习惯
时刻考虑代码的可复用性
每个人需要有每周项目进度报告

3. 代码规范

3.1 有关命名

尽量保证能够通过变量名得知变量的含义

3.1.1 包命名

包命名采用全小写命名
通过唯一域名+组件来命名

3.1.2 类命名

类命名采用Pascal命名法
大写字母开头，各个单词首字母大写

3.1.3 方法命名

方法命名采用Camel命名法
小写字母开头，各个单词首字母大写
属性的getter和setter方法尽量使用自动生成，并放在程序的后面。
Boolean类型的属性的get方法应形如isProperty()

3.1.4 变量命名

采用Camel命名法
小写字母开头，各个单词首字母大写
特有大写缩写词汇保持大写如：SQL
变量名字不宜过长，可适当采用缩减英文元音字母来缩短长度
假如缩短后名字重复，可以保留其中一个的部分元音字母

3.1.5 常量命名

采用全大写命名法
所有字母均大写

3.1.6 页面文件命名

采用全小写命名法
所有的字母均小写，单词之间以下划线’_’分隔
展示页面，按照名词+描述，如：news_list.jsp
操作页面，按照名词+动词命名，如：news_add.jsp
按照模块从大到小命名，如：news_order_add.jsp

3.1.7 资源文件命名

采用全小写命名法
按照前缀+模块+描述+状态命名，如：btn_main_login_pressed.png
(不一定完全包含如上4个部分，但是要依照顺序命名)

3.2 有关注释

团队成员都应该形成良好的写注释的习惯，方便以后阅读，以及为了后期生成可读性良好的Java Doc

3.2.1 程序文件头注释

应该包含如下：
* 文件描述
* 作者
* 版本
* 创建日期时间
* 修改日期时间
* 参考信息

提前设置好文件的模板Template
如以下模板：

/*** Description: * Author: KevinLee* Version: 1.0* Create Date Time: ${DATE} ${TIME}.* Update Date Time: * @see */

3.2.2 方法头注释

一般在写完一个方法后使用快捷键生成一个块注释，IDE会自动帮我们写入一些信息。
应该包含如下信息：
* 方法描述 Description:
* 参数信息 @param
* 返回信息 @return
* 异常信息 @Exception
* 参考信息（可选）@see also //指定一个类或者方法（通过类后面加#选择方法）
* 笔记信息（可选）Note:
如以下模板：

/*** Description: 返回一个“Hello”字符串* @param str 一个字符串* @return 返回一个字符串* @throws Exception  抛出一个异常* @see com.lidengju.entity.Person* Note: Nothing much.*/
public  String  sayHello(String  str) throws  Exception{str="Hello";return  str;
}

注意：方法里面不要使用块注释

3.2.3 关键点注释

应该包含如下信息：
* 一些程序关键的地方
* 一些程序不易读的地方
* 编写代码过程中遇到问题的地方
* 需要提示读者的地方

注释应该写得少而易懂
若修改了文件，可以加上修改人的信息，和修改日期。

4. 格式规范

4.1 缩进

应注意使用format来格式化代码，使用Tab键来缩进代码，相当于4个空格。

4.2 换行

{}花括号应该另起一行，左花括号与方法名、类名在同一行。(除了数组初始化时的花括号)
if、while等语句，假如体内只有一句代码也不要省略{}，为了方便以后的增删
字符串过长考虑拆分成多行

4.3 对齐

{}括号等应该对齐
类和方法的块注释必须紧贴类和方法
单独起行的//注释必须对齐被注释语句

5. 写在后面

希望各位成员遵守这份开发规范文档，养成良好的开发习惯

Java项目开发规范参考相关推荐

Java后台项目开发规范
Java后台项目开发规范写在前边 1.目标 2. 原则一.命名规范 1.包命名规范 2.类命名规范[**UpperCamelCase命名法**] 2.1==如果在模块或者接口,类,方法中使用了设计 ...
「 Java开发规范」10人小团队Java开发规范参考这篇就够了
<菜鸟程序员成长计划>之团队高效合作[开发规范篇] 1.「 Java开发规范」10人小团队Java开发规范参考这篇就够了! 2.「前端开发规范」10人小团队前端开发规范参考这篇就够了 ...
eclipse java代码某一行需要修改注释_看看这些Java代码开发规范吧！你好，我好，大家好！...
作为一名开发人员,当你接手他人的项目时,且当你阅读他人的代码时,是有没有遇到脑袋充血,感觉Java要把你"送走"的感觉呢?我们在用Java开发技术进行开发前,一定要牢牢恪守Java ...
oracle窗帘位图索引,Greenplum数据库设计开发规范参考.docx
Greenplum数据库设计开发规范参考 Greenplum数据库设计开发规范参考文档2016年7月目录Greenplum数据库设计开发规范1V1.511 前言41.1 文档目的41.2 文档范围4 ...
Laravel 项目开发规范
一. 说明以下内容大部分引用Laravel China社区的文章 - 分享下团队的开发规范 --<Laravel 项目开发规范>. 相对而言,上面引用的文章的规范更加严格,但考虑到目前的 ...
Java项目开发：学生社团管理系统
Java项目开发:学生社团管理系统 @author:Mr.Gu @date:2021/5/31 文章目录 Java项目开发:学生社团管理系统项目需求开发环境项目效果二.项目源码 1.创建登录J ...
前端规范 - 前端项目开发规范
0 前言好好做业务,提高自己的工程能力 [强制] 1 开启eslint 根据团队的习惯,制定适合自己的rules 比如 no-console no-debugger可以关闭 [强制] 2 新项目使用 ...
Java项目开发，学生信息管理系统
Java项目开发,学生信息管理系统 @author:Mr.Gu @date:2020/5/31 开发时间大二年级,数据结构综合实习文章目录 Java项目开发,学生信息管理系统开发效果开发要求开 ...
java项目开发实践 pdf_Java项目开发实践覃遵跃.pdf
高等学校软件工程专业校企深度合作系列实践教材 Java项目开发实践总主编周清平主编覃遵跃副主编陈园琼张彬连彭耶萍王新峰 ( ) 图书在版编目 CIP 数据 / 高等学校软件工程专业 ...
【Java后台开发规范】--- 圈复杂度
文章目录前言其他类型的规范圈复杂度提炼方法 if.else 卫语句去else 策略模式 switch 循环嵌套其他建议前言做Java开发的,大多数可能都有看过阿里的Java后台开发手册 ...

Java项目开发规范参考