互联网行业研发部开发人员代码编写手册.docxVIP

互联网行业研发部开发人员代码编写手册

互联网行业研发部开发人员代码编写手册

文档说明

目的：统一研发团队编码规范、提升代码可读性、可维护性、降低线上缺陷、便于代码评审、交接与问题排查；

适用范围：研发部所有后端、前端、移动端、测试开发、运维开发人员；

适用语言：Java/Go/Python/JavaScript/TypeScript/SQL（可根据团队业务自行增删）；

基本原则：可读性优先、简洁克制、防御性编程、可测试、敬畏线上；

优先级：安全正确性可读性性能代码简洁；

补充规则：语言特有规范优先对应语言官方规范，本手册为通用强制基线。

一、通用编码总则（所有开发强制遵守）

1.1命名规范

见名知意，禁止拼音缩写、无意义变量名

?a、b、temp、data、info、xx、sjh、userxx

?userOrderList、paymentStatus、cancelOrderTime

禁止中英文混合命名，禁止中文命名；

常量：全大写下划线分隔MAX_RETRY_COUNT；

布尔变量建议使用is/has/can前缀：isDeleted、hasPermission、canSubmit；

循环临时变量：短循环可用i,j，多层嵌套禁止；超过3行循环必须使用业务名称。

数据库表/字段：小写+下划线，禁止驼峰。

1.2注释规范

注释是解释