命名规则定义文档：代码规约与数据库规约

"命名规则定义文档1" 在软件开发中，规范的命名规则对于代码的可读性、可维护性和团队协作至关重要。本文档由王世泽等人编写，旨在为项目成员提供一套清晰的代码规约，特别是关于命名风格的指导。 1. 基本命名原则 - 不允许以下划线或美元符号开头和结尾：这是为了防止与特殊字符混淆，确保名称的合法性。 - 禁止拼音与英文混合：这样可以保持一致性，避免因混合语言造成理解困难。 - 禁止直接使用中文：英文命名有助于跨语言环境的理解，便于团队协作和国际化。 2. 类命名 - 遵循UpperCamelCase风格（驼峰命名法），但领域模型的命名有例外，如DO（Data Object）、BO（Business Object）、DTO（Data Transfer Object）、VO（View Object）等。 - 示例：正确的类名如`MarcoPolo`、`UserDO`，错误的如`_name`、`macroPolo`。 3. 方法、参数、变量命名 - 使用lowerCamelCase风格：变量名首字母小写，后续每个单词首字母大写，如`userName`、`tcpUdpDeal`。 - 常量全大写，用下划线分隔单词，如`MAX_SIZE`、`API_KEY`，以增加可读性。 4. 数组命名 - 数组定义时，中括号被视为类型的一部分，如`int[] array`。 5. 层级命名规约 - Service/DAO层方法： - 获取单个对象：`getXXX` - 获取多个对象：`listXXX` - 统计值：`countXXX` - 插入：`save`或`insert` - 删除：`remove`或`delete` - 修改：`update` 6. 领域模型命名 - 数据对象：以DO结尾，如`UserDO` - 数据传输对象：以DTO结尾，如`OrderDTO` - 展示对象：通常用于视图展示，如`ProductVO` 遵循这些命名规则，可以使代码更具可读性，降低理解成本，提高团队之间的沟通效率，同时也有助于减少潜在的编程错误。在实际开发中，开发者应始终遵守这些规约，以保持代码的整洁和一致性。