Java代码规范--排版,命名---以及一个例子
一 排版规范
1:对于变量的初始化赋值时候,= 要对齐,这样看着整齐舒服
// Before private Char joe = 'joe';private Char johnny = 'johnny';private Char quaid = 'quaid'; // Afterprivate Char joe = 'joe';private Char johnny = 'johnny';private Char quaid = 'quaid';
2:关键词或者变量和操作符之间加一个空格:
for(int i = 0; i < 10; i++) { int iCont = 1; }
3: 相对独立的代码块与块之间加空行,例如方法之间加上空行
4:较长的语句、表达式要分成多行书写
5:main方法写在整个类的底部
二 命名规范
1:包的命名,全部是小写字母
2:Class名以及成员变量名,方法名遵循驼峰规则
3:Class 中 Static Final 变量的命名,static Final 变量的名字应该都大写,并且指出完整含义。
三 注释规范
1:类,方法的注释采用 eclipse 自动生成方法。 /**
当把一个类,或方法的声明写完整后,在类,方法的正上方(不许有空格)在英文输入
法状态下输入:/** 后,系统会自动生成他们的注释模板,我们只需要填写相应的说明文字
即可,注意:/**的下一行一定要写功能说明。
四 例子
/** * Java编码格式个人推荐,参考JDK源码和Hyperic HQ源码(原spring旗下著名开源软件,现vmware)。 * @author lihzh(苦逼coder) * 本文地址:http://mushiqianmeng.blog.51cto.com/3970029/737120 */ public class CodeRule { //声明变量,等号两边有空格。 private static int i = 1; //方法声明,右括号和左大括号中间有空格。 public static void main(String[] args) { //if语句,比较连接符(>)左右有空格,小括号和大括号中间有空格。 //if 与 左括号中间有空格 if (i > 0) { System.out.println(i); } //两个条件的连接(&&),左右有空格。 if (i > 0 && i < 2) { System.out.println(i); } //if..else 语句两种格式 //1.参考JDK,个人使用方式,else跟大括号,前后都有空格 if (i > 0 && i < 2) { System.out.println(i); } else if (i > 2) { System.out.println(i + 1); } else { System.out.println(i); } //2.参考Hyperic HQ源码, else另起一行,后仍有空格 if (i == 1) { System.out.println(i); } else { System.out.println(i); } //while语句,与if语句类型,while与括号中间有空格,括号内格式与if相同 while (i > 0 && i < 2) { System.out.println(i); i++; } //for语句,两种格式 //1.参考Hyperic HQ,个人使用方式。分号后带空格,每个子语句中,连接符左右都带空格。 //for与括号中间带空格,大小括号中间带空格。 for (int j = 0; j < 10; j++) { System.out.println(i); } //2.参考JDK,区别在于子语句中,连接符左右无空格。 for (int j=0; j<10; j++) { System.out.println(i); } //+-*/,格式,四则运算符号前后有空格。 //在JDK的有些代码里,在方法调用的参传递或在判断语句中存在的四则运算中,四则运算符号前后无空格。 //为了不造成困扰和混淆,个人为均保留空格。 int a = 1 + 2; int b = 1 - 2; int c = 1 * 2; int d = 1 / 2; //三元表达式格式,每个符号中间均有空格 int j = i > 2 ? 1 : -1; //方法声明和调用,用逗号分隔的参数,逗号后有空格。 sum(a, b); sum(c + d, j); } //方法声明,多个参数,逗号后有空格 private static int sum(int i, int j) { return i + j; } }