Java代码规范与命名指南
"JAVA代码规范" Java代码规范是编程实践中的一项重要指导原则,旨在提升代码的可读性、可维护性和团队协作效率。本规范基于SUN的Java代码规范,并根据公司实际需求进行了调整。以下是对Java代码规范的详细解读: 1. **标识符命名规范** - **概述**:标识符的命名应遵循统一、达意和简洁的原则。统一意味着在项目中对相同概念使用一致的命名,避免混淆;达意要求标识符能准确反映其代表的含义,避免使用模糊或错误的命名;简洁则是在保持统一和达意的基础上,尽量减少字符数量。 - **骆驼法则**:大部分情况下,采用骆驼命名法,即将每个单词的首字母大写,如`supplierName`,避免下划线分隔的命名方式如`supplier_name`。 - **英文与拼音**:优先使用英文单词,如果遇到生僻词,可以寻求团队帮助,若无合适英文,再考虑使用汉语拼音。避免混合使用拼音与英文,如避免使用`guiDang`。 2. **包名** - 包名全为小写字母,单词间不使用下划线或其他字符分隔,例如`com.xxx.settlement`,而非`com.xxx.Settlement`。 3. **类名和接口名** - 类名和接口名同样遵循骆驼命名法,首字母大写,如`TargetSupplier`。 4. **方法名** - 方法名使用小写字母开头的骆驼命名法,如`addNewContract`,表示动作或功能。 5. **变量名** - 变量名应明确其用途,如`targetSupplier`,避免使用无意义的数字后缀,如`supplier1`。 6. **常量名** - 常量名通常使用全大写字母并用下划线分隔单词,如`MAX_SIZE`。 7. **避免使用单字母变量名** - 除非在循环等特定场景,否则应避免使用单字母变量名,如`i`,`j`,以提高可读性。 8. **注释** - 提供清晰的注释,解释复杂逻辑或关键代码段的作用,注释应简洁明了,及时更新。 9. **空格和缩进** - 使用标准的空格和缩进来增强代码的视觉结构,例如,通常在逗号、分号后添加空格,缩进使用4个空格。 10. **代码风格一致性** - 整个项目应保持一致的代码风格,包括括号的放置位置、换行规则等。 11. **异常处理** - 明确指定可能抛出的异常类型,避免使用笼统的`Exception`。 12. **代码长度和复杂度** - 避免过长的方法和过复杂的条件语句,尽可能将代码拆分为可读性强的小函数。 遵循这些规范,可以提高代码质量,降低代码维护成本,同时也有利于团队成员之间的沟通与协作。
![](https://csdnimg.cn/release/download_crawler_static/19097039/bg5.jpg)
![](https://csdnimg.cn/release/download_crawler_static/19097039/bg6.jpg)
剩余25页未读,继续阅读
![docx](https://img-home.csdnimg.cn/images/20210720083331.png)
![docx](https://img-home.csdnimg.cn/images/20210720083331.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://profile-avatar.csdnimg.cn/a3a5dd7b1f7d444da80e78dda23aa4c9_fandaozi01.jpg!1)
- 粉丝: 2
- 资源: 47
我的内容管理 展开
我的资源 快来上传第一个资源
我的收益
登录查看自己的收益我的积分 登录查看自己的积分
我的C币 登录后查看C币余额
我的收藏
我的下载
下载帮助
![](https://csdnimg.cn/release/wenkucmsfe/public/img/voice.245cc511.png)
最新资源
- 中国微型数字传声器:技术革新与市场前景
- 智能安防:基于Hi3515的嵌入式云台控制系统设计
- 手机电量低时辐射真增千倍?解析手机使用谣言
- 56F803型DSP驱动的高精度大功率超声波电源控制策略研究
- ARM与GPRS结合的远程监测系统设计
- GPS与RFID技术结合的智能巡检系统设计
- CPLD驱动的低功耗爆炸场温度测试系统设计
- 基于FPGA的智能驱动控制系统:可扩展设计与工业网络协议
- 基于ATmega128和CH374的嵌入式USB接口设计
- 基于AT89C52的温度补偿超声波测距仪:高精度设计与应用
- MSP430F448单片机在交流数字电压表中的应用
- 提升变频器应用效率的12项实用技巧
- STM32F103在数字电镀电源并联均流系统中的应用
- PSpice仿真下的升压开关电源设计:拓扑分析与CCM稳定性提升
- 轻巧高效:MSP430主导的低成本无线传感器网络节点设计
- FPGA在EDA/PLD中实现LVDS接口的应用解析
![](https://img-home.csdnimg.cn/images/20220527035711.png)
![](https://img-home.csdnimg.cn/images/20220527035111.png)
![](https://csdnimg.cn/release/wenkucmsfe/public/img/green-success.6a4acb44.png)