Java编程规范详解:命名与源文件样式

需积分: 9 2 下载量 8 浏览量 更新于2024-09-13 收藏 78KB DOC 举报
"Java编程规范是为了提升代码的可读性、兼容性和维护性,涵盖了命名规范、源文件样式等多个方面。以下是对这些规范的详细解释: 1. **命名规范** - **Package命名**:包名应全部小写,通常以公司的国际域名开头,如`com.te`,确保包的全局唯一性。 - **Class命名**:类名必须大写字母开头,后续单词首字母也大写,如`DbAccess`。 - **成员属性和变量命名**:变量名应小写字母开头,后续单词首字母大写,如`private String lastName`。 - **常量命名**:常量使用`static final`修饰,全大写加下划线分隔,如`public static final String ORACLE_DB_DRIVER = "oracle.jdbc.driver.OracleDriver"`,名称应具有完整性。 - **数组命名**:数组变量名推荐使用`byte[] buffs`,而非`byte buffs[]`。 - **方法参数**:参数命名应与变量相同,使用有意义的名称,尽可能与对应的属性同名,如`setCounter(int size)`。 - **方法命名**:方法名小写字母开头,后续单词首字母大写,存取方法使用`getXXX()`、`setXXX()`,布尔类型的方法用`isXXX()`、`hasXXX()`。 2. **Java源文件样式** - **Class代码布局**: - `package`声明应在文件顶部。 - 接下来是Javadoc注释或其他文件头注释。 - 类声明紧随其后。 - 字段声明,然后是一个空行。 - 构造函数,再次空行。 - 克隆方法,再空行。 - 其他方法按照逻辑顺序排列。 3. **其他注意事项** - 变量命名应使用有意义的英文单词或约定简写,如`public String zipCode`,`public int errNo`。 - 针对`Collection`类型的变量,如数组、Vector,应使用复数形式命名,如`public Collection customers`。 遵循这些规范可以提高代码的可读性和可维护性,便于团队协作,降低后期维护成本。在实际编程中,开发者还应根据项目需求和团队规定进行适当的调整和扩展。"