2025年软件行业研发部开发人员软件代码编写手册.docxVIP

2025年软件行业研发部开发人员软件代码编写手册

第1章基础规范与编码风格

1.1项目编码规则与命名规范

所有文件必须遵循统一的命名约定，采用PascalCase格式（如`userAuthController`），类名首字母大写，下划线分隔单词，避免使用驼峰命名法（如`UserAuthController`），以确保代码在IDE中的可读性和维护性。公共类、接口和工具类需使用大驼峰命名（如`UserService`），而私有辅助类、私有方法或内部工具函数则使用小驼峰命名（如`privateHelperUtil`），以此清晰地区分代码的公共性与私有性。

所有Java类必须包含一个名为`publicstaticfinal`的常量块，用于存放全局业务常量（如枚举值、配置参数、默认值），严禁在类内部定义常量，以避免命名冲突和修改困难。所有Java类必须包含一个名为`publicstaticfinal`的常量块，用于存放全局业务常量（如枚举值、配置参数、默认值），严禁在类内部定义常量，以避免命名冲突和修改困难。类名必须与包名（PackageName）完全一致，例如`com.example.service.UserService`对应的类名必须是`com.example.service.UserService`，严禁出现包名与类名