这里规定并说明了编写具体代码时的编码规则。所有开发人员必须无条件遵守,
并按照这个编码规则来编写代码。如有不足,不合理的地方请提出来,看项目
情况来修正。※本文没有特别声明的英文字母,和阿拉伯数字全是半角。
1.1.对象顶部JavaDoc注解
1.2.全局变量JavaDoc注解
1.3.方法的JavaDoc注解
1.4.普通程序当中注解
1)对象内所有的变量(包括临时变量)都要在后面写注解。
2)所有的分支if,else,case,for,switch,while,do 等等..的
上边都得对齐写注解。
2.缩紧:代码的层次用{TAB}或4位半角空格来表示。
3.代码间的间隔
语句和语句间留1位半角空格。
1)(=, >, <, == 等)等运算符前后留1位半角空格。
2)if、for、while、switch、do 后面留1位半角空格。
3)参数内逗号的后面留1位半角空格。
4)方法、if、for、while、switch、do关闭括号后面留1位半角空格。
5)for语句的[;]后插入半角空格。
【代码例子 1)和3)】
【代码例子 2)和4)和5)】
※使用编译器的自动对齐功能
『Eclipse』里头打开Java代码,点击鼠标右键〉源代码〉格式化,
功能。 这个功能和以上是一样的,可以使用这个功能方便的自动对齐。
4.类名、变两名、方法名
无特别指定时,遵照以下规则
4.1.类名
头字母和区分单词的头文字大写半角英文字母、以外全部小写半角
英文字 母.
例) public class SchoolStaff {
4.2.方法名
区分单词的头文字大写半角英文字母、以外全部小写半角英文字母.
例) public void calcDiscount() {
4.3.变量名
有区分单词的场合使用大写半角英文字、以外全部小写半角英文字母.
例) private int billed;
4.4.常数名
全部是大写半角英文字母、有单词区分时用下划线「 _ 」表示。
例) public static final float DISCOUNT_RATE = 0.1f;
5.代码过分长的时候
例)double length = Math.sqrt(Math.pow(Math.random(), 2.0)
+ Math.pow(Math.random(), 2.0));
5.1.方针(1)
能分开写两行代码时,分开写两行代码
例)double xSquared = Math.pow(Math.random(), 2.0);
double ySquared = Math.pow(Math.random(), 2.0);
double length = Math.sqrt(xSquared + ySquared);
5.2.方针(2)
以逗号为界换行,但换行后保持对应按数缩紧一致
例)double length = Math.sqrt(Math.pow(Math.random(), 2.0,
Math.pow(Math.random(), 2.0);
public ActionForward execute(ActionMapping mapping,
ActionForm actionForm,
HttpServletRequest request,
HttpServletResponse response) {
5.3.方针(3)
以||,&&为界线换行,但换行后保持对应按数缩紧一致
例)return this == obj
|| (this.obj instanceof MyClass
&& this.field == obj.field);