1.Java程序规范
1.1.命名规范
◆包
Package 的名字应该都是由一个小写单词组成，例如：com.hongdi.webgpsmon。
此外，对于包名我们做如下约定：
1、工具函数类包名前缀为.util
2、Servlet类包名前缀为.servlet
3、test case类包名前缀为.test
◆类，接口
Class 的名字应该使用名词，必须由大写字母开头而其他字母都小写的单词组成，例如：DataFile或InfoParser。
◆方法
1、第一个单词一般是动词。
2、第一个字母是小写，但是中间单词的第一个字母是大写。
3、方法名不要使用缩写，如果方法返回一个成员变量的值，方法名一般为get+成员变量名，如若返回的值是bool变量，一般以is作为前缀。如果方法修改一个成员变量的值，方法名一般为：set + 成员变量名。例如：getName(); 或setName(); 或 isFirst(); 。 
◆变量
1、变量的名字必须用一个小写字母开头。后面的单词用大写字母开头，例如：debug 或 inputFileSize。
2、在结尾处放置一个统一的量词，例如：strCustomerFirst和strCustomerLast，量词列表：
量词后缀
说明
First
一组变量中的第一个
Last
一组变量中的最后一个
Next
一组变量中的下一个变量
Prev
一组变量中的上一个
Cur
一组变量中的当前变量
3、给布尔变量命名时，始终都要使用变量的肯定形式，例如：bIsExit
4、尽量缩小变量的作用域
◆常量
常量的名字应该都大写，单词间以‘_’隔开，并且指出完整含义，例如：Static Final  MAX_UPLOAD_FILE_SIZE=1024。
◆参数
参数的名字必须和变量的命名规范一致。
◆数组
数组应该总是用下面的方式来命名：
byte[] buffer;
而不是：
byte buffer[];
◆方法的参数
使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：
SetCounter(int size)
{
  this.size = size;
}
1.2.Java文件样式
所有的 Java(*.java) 文件都必须遵守如下的样式规则：
◆文件头
源文件的头部需要一个history段，对于每次对源文件的重大改动，都需要在history段中注明。该段定义在package和import之间，例如：
/**
* <p>Title: 通用WEB底层框架系统</p>
* <p>Description: 系统缓冲加载，包括数据字典、系统参数</p>
* <p>Copyright: Copyright (c) 2009</p>
* <p>Company: hongdi</p>
* @author lhc
* @version 1.0
*/
◆Package/import
import包按以下顺序：
1、jdk标准包
2、java扩展包（例如servlet，javamail，jce等）
3、使用的外部库的包（例如xml parser）
4、使用的项目的公共包
5、使用的模块的其他包
每一类import后面加一个换行。
例如：
import java.io.*;
import java.util.*;
import javax.servlet.*;
import javax.mail.*;
import l.*;
import com.hongdi.webgpsmon.*;
import com.del.system.login.Operator;
◆Class
1、类定义
2、类的成员变量
/**
* Packet counters
*/
protected int[] packets;
java配置用户变量
public 的成员变量必须生成文档(JavaDoc)。
proceted、private和 package 定义的成员变量如果名字含义明确的话，可以没有注释。
3、构造函数
它应该用递增的方式写(比如:参数多的写在后面)。
4、类方法
       
1.3.代码格式                                                     
◆代码块书写格式
可以选择以下任意一种代码块的书写方式：
if (true){
//body
}
if (true)
{
    //body
}
建议使用第二种书写方式。如果是修改他人的代码，必须使用代码原来的书写方式。
对于代码块过长，超过1屏以上，}后面要说明属于那个代码块，例如：
if (i > 100)
{
    //too many lines more than one screen
}// if (i > 100)
◆关于缩进
缩进使用4个连续空格，不要在源文件中保存tab字符， 请注意调整所用的IDE工具，打开将tab转换为空格功能。
◆页宽
页宽应该设置为80字符. 源代码一般不会超过这个宽度, 并导致无法完整显示, 但这一设置也可以灵活调整. 在任何情况下, 超长的语句应该在一个逗号或者一个操作符后折行. 一条语句折行后, 应该比原来的语句再缩进4个空格。
◆操作符
操作符左右各用一个空格分隔。
例如：
int a = b;
if (a > 0);
◆SQL语句
代码中书写的sql语句要求sql关键字全部小写，表名和字段名大写。例如：
SELECT user_id, name FROM account WHERE user_id > ? AND depart = ? ORDER BY name
◆类和方法定义
类定义或方法定义过长需要换行书写，例如：
public class CounterSet
      extends Observable
      implements Cloneable
private PortletSet getPortlets( Portlets portlets,
                        RunData rundata,
                        boolean application,

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。