Java编码规范0精要.docVIP

编码规范说明文档初稿 作者：董文 说明 文档中使用红色字体标注的需要特别注意，要牢记。 此文档版本是1.0，以后修改就可以命名为1.1,1.2等等，方便管理，看的时候只需要看最新版本就可以了。 目录 1 代码布局规则 4 2 代码书写规则 7 3 命名规则 12 4 声明规则? 16 5 表达式和语句规则 18 6 注释规则 22 7 初始化和回收规则 24 1 代码布局规则 每一个Java源文件都包括一个公共的类或接口。当私有类或接口与公共类相关联的时候，通常可以将其与公共类放在同一个源文件当中。公共类应是文件中的第一个类或接口。 类或接口的各部分代码顺序如下： Class或Interface 文档型注释 采用?????? /** ?* ?* ?*/ 型注释。 Class或Interface声明 类变量及变量实例 变量出现的顺序为，首先公共变量，然后是package可见的变量，然后是protected变量。 构造函数（Constructors） 方法finalize()，如果有。 public方法 package可见方法 protected方法 private 方法 内部类 private字段 main方法 package com.zte; ? import java.awt.peer.CanvasPeer; import java.io.*; import com.zte.ums.uep.*; ? /** ?* p文件名称: 题目名称/p ?* p文件描述: 简要描述本文件的内容，包括主要模块、函数及其功能的说明/p ?* @author? 作者姓名 ?*/ public class Test { } 【规则1_2】 在一个类中，布局顺序依次是：变量、构造方法、方法、内部类、main方法。 正例： public class Test { //变量定义 public int x; Public String str; //无参构造方法 public Test() { } //带参构造方法 public Test(int x, String str) { this.x = x; this.str = str; } //自定义方法 public int add(int a, int b) { return a+b; } //主方法 Public static void main (String [] args) { System.out.println(“编码规范”); } }public class Test { //变量定义 public int x; Public String str; //无参构造方法 public Test() { } //带一部分参数构造方法 public Test(int x) { this.x = x; } //带参构造方法 public Test(int x, String str) { this.x = x; this.str = str; } } public class OGM { void foo () {} void foo (int a) {? ???????????????????? //正确 } void bar () {} void bab () {} } 2 代码书写规则 【规则2_1】每行只有一个句子，提高代码可读性。 反例： public class OSPL { ???? int method (int a, int b) { ???????? int i = a + b; return i;? //违例 ???? } } public class OSPLFixed { ???? int method (int a, int b) { ???????? int i = a + b;? // 正确 ???????? return i; ???? ?// 正确 ???? } } ?someMethod(longExpression1, longExpression2, longExpression3, ????????????? longExpression4, longExpression5); ? var = someMethod1(longExpression1, ??????? ????????????someMethod2(longExpression2, ????????????? ???????????????????longExpression3)); 下面是两个断行算术表达式例子，第一个是优选方法，因为断行出现在括号表达式之外，属于较高级别的断行。 正例： ? longName1 = longName2 * (l