Java程序工程规范

一.为什么要有规范

软件开发是一个集体协作的过程,程序员之间的代码经常需要交换阅读,因此,Java源程序有一些约定俗成的规定,主要目的是提高可读性和方便管理.好的代码易于阅读为首要,效率高低才是其次.

二.Java程序编程规范

(1)格式规范:

a)缩进:

使用配置文件进行格式化： 配置文件中一个TAB等于4个空格.

b)行长度:

每行100字符.

c)声明变量与常量:

一行只声明一个变量或常量； 
在代码块的开始处声明实例变量,该尽量不要在首次用变量时才声明.

d)声明类和方法:

声明语句后紧跟"{","}"另起一行,方法与方法之间空一行.

e)语句:

eclipse中可用快捷键Ctrl+Shift+F整理代码,Android Studio中可用快捷键Ctrl+Alt+L整理代码

f)空格:

双目运算符左右各有一个空格:

int i = 1;

int j = 1 + i;

标点符号后面跟一个空格:

int i, j;

for(i = 1; i < 5; i++){}

addContent(view, params);

(2)命名规范:

a)包名中的字母一律小写;

net.frontfree.javagroup

b)类名,接口名的每个单词首字母大写:

class AddValues{}

interface AddValues{}

c)局部变量或方法名第一个单词字母小写,后面的每个单词首字母大写:

public void addValues(){}

string addValues;

d)常量中的每个字母大写,如果常量名由多个单词组成,则单词与单词之间用下划线隔开:

public static final String SUNDAY;

public static final String ADD_VALUES;

(3)注释:

程序注释量一般在20%~50%;

程序注释内容有:

1.程序头说明:注释为/**说明部分(一般为文档标题,描述,版权,作者,版本信息等)*/

内容和关键字用空格隔开:   

 @author<作者>

@version<版本>

@see<想关内容和类>

@since<被内容在哪个版本之后开始出现>

2.方法说明:用于说明本方法的主要用途以及实现的基本思路

@param<属性名称或参数说明>

@return<返回值说明>

@exception<例外说明>

@throws<异常类>

@deprecated<功能逐渐被淘汰说明>

3.属性说明;

程序注释方式:

多行注释:/*文字或程序语句*/

单行注释://文字或程序语句

以上为我觉得常用到的,如果觉得不够详细,请参考下面的博客或书籍;

本文参考:http://blog.csdn.net/mynameishuangshuai/article/details/51364944

Java面向对象程序设计(第二版)---清华大学出版社