啊对对队项目开发规范v1.0.0 - 命名与代码风格指南
需积分: 0 179 浏览量
更新于2024-08-04
收藏 28KB DOCX 举报
"啊对对队项目开发规范v1.0.01"
本文档是针对啊对对队项目的开发规范,旨在提供一套清晰、统一的编程标准,提高代码质量和团队协作效率。规范主要包括命名风格、常量定义、代码格式、日期时间、控制语句和注释规约等多个方面。以下是对这些规范的详细解读:
### 命名风格
1. **强制性**:任何命名都不允许以下划线`_`或美元符号`$`开头或结尾。这有助于保持命名的一致性和专业性,避免产生混淆。例如,`_name`, `__name`, `$name`, `name_`, `name$`等都是不被允许的。
2. **强制性**:编程中的命名禁止使用拼音与英文混合的方式,同时也禁止直接使用中文。使用正确、完整的英文单词可以提高代码的可读性,减少误解。例如,`DaZhePromotion`、`getPingfenByName`、`Stringfw`和`某变量`应避免,而`discountPromotion`、`getScoreByName`、`stringFramework`和`someVariable`则是更合适的选项。
3. **强制性**:类名遵循UpperCamelCase(驼峰命名)风格,但特定类型如DO(Data Object)、BO(Business Object)、DTO(Data Transfer Object)、VO(View Object)、AO(Application Object)、PO(Persistence Object)、UID(User Identification)等可以例外,使用全大写字母。例如,`ForceCode`, `UserDO`, `HtmlDTO`, `XmlService`, `TcpUdpDeal`, `TaPromotion`是正确的,而`forcecode`, `UserDo`, `HTMLDto`则不符合规范。
### 其他章节简述
- **常量定义**:这部分可能涉及如何定义常量,例如使用全大写字母和下划线分隔单词,以及如何合理地表达常量的含义。
- **代码格式**:涵盖了代码缩进、空格使用、行宽限制、括号配对等方面的规则,旨在提升代码的整洁度。
- **日期时间**:可能包括如何正确处理日期和时间对象,如避免使用易出错的`Date`类,提倡使用`LocalDateTime`等现代API。
- **控制语句**:强调了如何有效使用if-else、switch-case、for、while等语句,以及避免使用复杂的嵌套结构。
- **注释规约**:规定了注释的写法,如Javadoc的使用、单行和多行注释的格式,以及何时应该添加注释来提高代码可读性。
该开发规范还特别推荐配合阿里发布的Java开发规约IDE插件使用,以实时检查并提示编码过程中的不合规情况。此外,规范的版本为v1.0.0,最后更新于2021年10月29日,随着项目的发展,可能还会进行更新和改进。
遵循这些规约,开发者可以编写出更易读、更易维护的代码,从而提升整个项目的质量。
2020-11-09 上传
2021-08-09 上传
2022-10-23 上传
2021-10-12 上传
2022-04-15 上传
2020-05-19 上传
2018-03-10 上传
2022-01-27 上传
巴蜀明月
- 粉丝: 40
- 资源: 301
最新资源
- ES管理利器:ES Head工具详解
- Layui前端UI框架压缩包:轻量级的Web界面构建利器
- WPF 字体布局问题解决方法与应用案例
- 响应式网页布局教程:CSS实现全平台适配
- Windows平台Elasticsearch 8.10.2版发布
- ICEY开源小程序:定时显示极限值提醒
- MATLAB条形图绘制指南:从入门到进阶技巧全解析
- WPF实现任务管理器进程分组逻辑教程解析
- C#编程实现显卡硬件信息的获取方法
- 前端世界核心-HTML+CSS+JS团队服务网页模板开发
- 精选SQL面试题大汇总
- Nacos Server 1.2.1在Linux系统的安装包介绍
- 易语言MySQL支持库3.0#0版全新升级与使用指南
- 快乐足球响应式网页模板:前端开发全技能秘籍
- OpenEuler4.19内核发布:国产操作系统的里程碑
- Boyue Zheng的LeetCode Python解答集