软件行业技术部开发人员代码编写标准手册 (2).docxVIP

软件行业技术部开发人员代码编写标准手册

第1章代码风格规范

1.1命名规范

1.1.1类名与接口名

类名应使用PascalCase（首字母大写，后续单词首字母也大写），如`UserRepository`或`ApiService`。接口名通常遵循相同的规则，但需体现其抽象性或功能性，例如`IUserService`。

为什么？因为PascalCase在Java、C等语言中已成共识，能直观区分命名空间与实现。一个混乱的命名习惯，比如混用`CamelCase`和`snake_case`，会让团队在合并代码时耗费额外时间——根据统计，混用命名规范的冲突率比统一规范高出30%。

1.1.2方法名与变量名

方法名和变量名建议使用camelCase（首字母小写，后续单词首字母大写），如`calculateTotalPrice`或`userId`。避免使用单个字母的变量名，如`i`，除非在循环中临时使用。

场景举例：一个200行的方法，如果用`temp`或`data`作为占位符变量，后续调试时极难追踪其作用域。相反，`calculateDiscountRate`这样的命名能直接传递语义。

1.1.3常量名

常量（如静态final变量）应使用ALL_CAPS，单词间用下划线分隔，如`MAX_TIMEOUT`或`DEFAULT_PAGE_SIZE