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

软件行业技术部程序员代码编写手册

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

1.1全局命名规范与常量定义

遵循“大驼峰命名法”（PascalCase）作为全局命名标准，所有类名、接口名、常量名及关键变量名首字母大写，其余字母小写，例如`UserService`或`MAX_RETRY_COUNT`，避免使用`UserService`或`max_retry_count`等不符合惯例的命名方式，确保代码结构清晰且易于人类阅读。

常量值的类型必须严格匹配其用途，数值常量应使用整数类型`number`，布尔常量使用`boolean`，字符串常量使用`string`，且数值常量应遵循幂进制的科学计数法表示，例如`constMAX_PAGE_SIZE=1000;`而非`1000`，以统一数据量级的表达习惯。在定义常量时，必须为变量添加有意义的中文注释，解释该常量的业务含义，例如`constAPI_TIMEOUT=30000;//接口超时时间设为30秒，防止请求挂起影响用户体验`，避免代码仅依赖注释而缺乏上下文，确保新接手人员能理解业务逻辑。常量定义应遵循“单一职责”原则，避免在同一个文件中定义三个以上的不同常量，例如不要将`DEFAULT_TIMEOUT`、`MAX_RETRY_COUNT`和`API_VERSION`混在一起，而是拆分