文档介绍：FEEL-View
(通用)
文件状态:
[√] 草稿
[ ] 正在修改
[ ] 正式发布
起草:
吕建明
当前版本:
根据文件名称中编号决定
审核意见:
开发组长填写(通过或继续修改)
审核意见:
技术总监填写(通过或继续修改)
JAVA编码规范
目录
1- 文件名 5
5
经常用到的文件名包括: 5
2- 文件组织 5
3- Java源程序 5
package和import语句 5
package语句 5
import 语句 6
类或接口申明 6
4- 缩进 7
行的长度 7
换行总则 7
5- 括号 8
6- 注释 9
程序注释 9
块注释 9
单行注释 10
行尾注释 10
整行注释 10
特殊注释 11
7- 申明 11
每行申明数 11
初始化 11
类和接口申明 12
8- 语句 13
单句 13
复合句 13
if 语句 13
for语句 14
while 语句 14
do-while语句 14
switch语句 15
try – catch 语句 15
9- 空行 16
空行 16
空格 16
10- 命名规范 16
11- 文档 18
class说明 18
方法说明 19
编程实践 19
访问实例和类变量 19
引用类变量和方法 20
变量赋值 20
代码示例 20
12 JSP与Sevlet的一些约定 22
JSP命名的约定 22
Sevlet方法的约定 22
JSP代码结构的约定处理 23
JSP与Sevlet分工的一些建议 23
13 一些常用的设计模式约定 23
单实例方式 23
创建者 23
说明
所有的程序开发手册都包含了各种规则,在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。定义这个规范的另一目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人接手工作而带来的延误。(这些规范并不是一定要绝对遵守,但是为了增进协同工作效率,一定要让程序有良好的可读性尤其是public方法和属性不可随意增删和命名)。
1- 文件名
文件类型
后缀
Java源程序
.java
Java字节码
class
经常用到的文件名包括:
文件名
用途
总结,说明同一目录下的内容
2- 文件组织
文件由多节组成,节由空行分开,可选的注释信息标识各节(section)。超过2000行的文件十分笨重,应该避免之。
3- Java源程序
每个java源程序包含单个公用类或接口,该公用类或接口应该是源文件中的第一个类或接口。Java 源程序按如下顺序组织:
package和import语句
package语句
大多数源程序中第一行非注释性行为package语句,紧接着空一行的才可以是import语句如:
package ; //package名全部小写
import ;
import 语句
尽量使用类所属package的全部修饰符,而不是通配符*,可知道类来自何package;避免
import .*;
import .*;
.brendonwilson.*;
import .*;
import .*;
而优先使用
import ;
import ;
import ;
import ;
import ;
import ;
/**
* Class prologue documentation.// 类的注释,一般是用来解释类的
*/
import语句按java标准库,扩展库的顺序分组罗列,分组内部按字母顺序排列, 分组间用