软件行业技术部程序员软件编码维护手册.docxVIP

软件行业技术部程序员软件编码维护手册

第1章项目编码规范与架构设计

1.1命名规则与编码风格指南

遵循统一的命名约定，采用PascalCase区分大小写，将类名、函数名和变量名首字母大写，例如`UserRepository`而非`userRepository`，以利于代码快速扫描和辅助开发。遵循BEM或类似语义化命名规范，在类名前加前缀如`__`或`__`，例如`__user__`，避免命名冲突并明确属性归属，如`user__name`。

常量使用UPPERCASE且添加下划线分隔，如`MAX_RETRY_COUNT=5`，并在全局导入文件中集中管理，防止拼写错误导致运行时异常。自定义枚举使用常量定义并添加注释，如`RoleEnum={ROLE_ADMIN:1,ROLE_USER:2}`，确保权限校验逻辑与枚举值严格对应，避免硬编码。函数参数名采用camelCase，如`processRequest`，返回类型使用`Return`前缀，如`processRequest()`，提升函数可读性并规范API契约。

避免使用`this`关键字作为变量名或类属性名，统一使用`self`或类名前缀，如`self.currentUser`，确保在继承链中变量作用域清晰。

1.2软件架构分层与模块划分