阿里巴巴Java编程规范:命名规约与异常处理
需积分: 10 176 浏览量
更新于2024-08-08
收藏 1.68MB PDF 举报
"编程规约-基于单片机的太阳能电池自动跟踪系统的设计"
这篇文档主要介绍了编程规约,特别是针对C和Java编程语言的命名、常量定义、格式、面向对象编程(OOP)、集合处理、并发处理、控制语句、注释以及异常日志等方面的规定。这些规约旨在提高代码的可读性、可维护性和团队协作效率。
1. **命名规约**
- **命名不得以下划线或美元符号开始或结束**:例如`_name`、`__name`、`$Object`、`name_`、`name$`、`Object$`都是不被允许的。
- **禁止混合拼音与英文命名**:应使用全英文命名,避免使用拼音,如`DaZhePromotion`、`getPingfenByName`、`int某变量=3`。
- **类名遵循UpperCamelCase风格**,除了领域模型的DO/BO/DTO/VO等特殊命名,如`MarcoPolo`、`UserDO`、`XmlService`、`TcpUdpDeal`、`TaPromotion`。
- **方法名、参数名、成员变量、局部变量使用lowerCamelCase风格**,如`localValue`、`getHttpMessage`、`inputUserId`。
- **常量命名全大写,单词间用下划线分隔**,如`MAX_STOCK_COUNT`,避免使用简写,如`MAX_COUNT`。
- **抽象类名以Abstract或Base开头**,异常类以Exception结尾,测试类以Test结尾。
- **数组定义时,中括号作为类型的一部分**,如`String[] args`,避免使用`String args[]`的定义方式。
2. **常量定义**
- 常量命名应该清晰且完整,比如`MAX_STOCK_COUNT`。
3. **格式规约**
- 这部分未提供具体内容,但通常会涵盖缩进、空格、换行等方面的规则,以保持代码整洁。
4. **OOP规约**
- 通常包括封装、继承、多态等原则的实施细节。
5. **集合处理**
- 可能包含对List、Set、Map等集合类型的使用规范,比如避免null元素、合理选择集合类型等。
6. **并发处理**
- 规定了多线程编程中的最佳实践,如同步机制、线程安全的集合使用等。
7. **控制语句**
- 提供了if、for、while等控制结构的使用建议,以提高代码质量。
8. **注释规约**
- 注释应当清晰、简洁,用于解释代码难以理解的部分,以及重要的设计决策。
9. **其它规约**
- 包含未分类的编程规范和建议。
10. **异常日志**
- 异常处理规约可能涉及异常的捕获、处理和记录。
- 日志规约可能包括日志级别、日志格式、日志输出的控制等。
11. **MySQL规约**
- 建表规约:指导如何设计数据库表,包括字段类型的选择、主键设计等。
- 索引规约:优化查询性能,规定何时创建索引及如何创建。
- SQL规约:编写高效、可读的SQL语句。
- ORM规约:在对象关系映射中的一致性规则。
12. **工程规约**
- 应用分层:描述应用程序的模块化和分层架构。
- 二方库规约:关于第三方库的使用和管理。
- 服务器规约:与服务器配置、部署和维护相关的最佳实践。
13. **安全规约**
- 针对数据安全、用户隐私保护等方面的规定。
这些规约是软件开发中的重要指南,有助于创建一致、高质量的代码库,提高团队合作效率,并降低维护成本。
2020-07-22 上传
2010-02-08 上传
点击了解资源详情
点击了解资源详情
点击了解资源详情
点击了解资源详情
点击了解资源详情
点击了解资源详情
羊牮
- 粉丝: 41
- 资源: 3864
最新资源
- 平尾装配工作平台运输支撑系统设计与应用
- MAX-MIN Ant System:用MATLAB解决旅行商问题
- Flutter状态管理新秀:sealed_flutter_bloc包整合seal_unions
- Pong²开源游戏:双人对战图形化的经典竞技体验
- jQuery spriteAnimator插件:创建精灵动画的利器
- 广播媒体对象传输方法与设备的技术分析
- MATLAB HDF5数据提取工具:深层结构化数据处理
- 适用于arm64的Valgrind交叉编译包发布
- 基于canvas和Java后端的小程序“飞翔的小鸟”完整示例
- 全面升级STM32F7 Discovery LCD BSP驱动程序
- React Router v4 入门教程与示例代码解析
- 下载OpenCV各版本安装包,全面覆盖2.4至4.5
- 手写笔画分割技术的新突破:智能分割方法与装置
- 基于Koplowitz & Bruckstein算法的MATLAB周长估计方法
- Modbus4j-3.0.3版本免费下载指南
- PoqetPresenter:Sharp Zaurus上的开源OpenOffice演示查看器