Java编程规范详解:命名与源文件样式
需积分: 9 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`。
遵循这些规范可以提高代码的可读性和可维护性,便于团队协作,降低后期维护成本。在实际编程中,开发者还应根据项目需求和团队规定进行适当的调整和扩展。"
2021-10-07 上传
2011-03-11 上传
2009-05-01 上传
2024-01-15 上传
2023-08-01 上传
2023-12-26 上传
2023-12-13 上传
2024-10-28 上传
2024-10-28 上传
小小星尘s
- 粉丝: 0
- 资源: 7
最新资源
- BottleJS快速入门:演示JavaScript依赖注入优势
- vConsole插件使用教程:输出与复制日志文件
- Node.js v12.7.0版本发布 - 适合高性能Web服务器与网络应用
- Android中实现图片的双指和双击缩放功能
- Anum Pinki英语至乌尔都语开源词典:23000词汇会话
- 三菱电机SLIMDIP智能功率模块在变频洗衣机的应用分析
- 用JavaScript实现的剪刀石头布游戏指南
- Node.js v12.22.1版发布 - 跨平台JavaScript环境新选择
- Infix修复发布:探索新的中缀处理方式
- 罕见疾病酶替代疗法药物非临床研究指导原则报告
- Node.js v10.20.0 版本发布,性能卓越的服务器端JavaScript
- hap-java-client:Java实现的HAP客户端库解析
- Shreyas Satish的GitHub博客自动化静态站点技术解析
- vtomole个人博客网站建设与维护经验分享
- MEAN.JS全栈解决方案:打造MongoDB、Express、AngularJS和Node.js应用
- 东南大学网络空间安全学院复试代码解析