深圳前湾燃机电厂#3机组（2025年度）汽轮机本体大修招标公告（原标题：深圳前湾燃机电厂#3机组（2025年度）汽轮机本体大修）

# 双端的前端代码规范

## 代码风格

### 缩进

使用 2 个空格进行缩进

### 换行

- 换行符使用 LF
- 每行代码不得超过 120 个字符
- 大括号的位置
- 左大括号前不换行
- 左大括号后换行
- 右大括号前换行
- 右大括号后还有 else 等代码时不换行；表示终止的右大括号后必须换行

### 空格

- 二元运算符前后空格
- 算术运算符：+、-、*、/、% 等前后各加一个空格
- 比较运算符：==、===、!=、!==、>、>=、<、<= 等前后各加一个空格
- 逻辑运算符：&&、||、! 等前后各加一个空格
- 逗号前后空格
- 数组、对象字面量中，逗号后面跟一个空格，前面不加空格
- 函数参数列表中，逗号后面跟一个空格，前面不加空格
- 函数调用时，函数名与左括号之间不加空格
- 代码块的大括号前加空格
- 关键字前后空格
- if、else、for、while、switch、case、default、try、catch、finally、function 等关键字后面跟一个空格
- return、throw、delete、typeof、void 等关键字前后各加一个空格

### 引号

- 字符串使用单引号('')
- HTML 属性值使用双引号("")

### 命名规范

- 变量名、函数名使用驼峰命名法（camelCase）
- 常量名使用全大写字母和下划线命名法（UPPER_CASE_UNDERSCORE）
- 类名使用帕斯卡命名法（PascalCase）
- 文件名使用小写字母和下划线命名法（lower_case_underscore）

### 注释

- 单行注释使用 //，多行注释使用 /* */
- 注释应简洁明了，解释代码的功能、目的、注意事项等
- 函数、类、方法等的注释应使用 JSDoc 格式

### 代码组织

- 每个文件只包含一个类或模块
- 模块之间通过 import 和 export 进行引用和导出
- 代码应按照功能进行分组，同类功能的代码应放在一起

## 代码质量

### 变量声明

- 变量使用 let 或 const 进行声明，优先使用 const
- 变量声明时应尽量靠近使用的位置
- 避免使用 var 声明变量

### 函数声明

- 函数应具有单一职责，功能明确
- 函数参数应尽量少，最多不超过 5 个
- 函数名应具有描述性，能够清晰表达函数的功能

### 条件语句

- if 语句应尽量简洁，避免嵌套过深
- 避免在条件语句中使用复杂的表达式
- 当条件语句的条件部分较长时，应将条件部分拆分成多个变量或函数

### 循环语句

- for 循环应尽量简洁，避免嵌套过深
- 避免在循环体内声明函数
- 当循环体内的代码较长时，应将循环体内的代码拆分成多个函数

### 错误处理

- 使用 try...catch 捕获异常
- 捕获到异常后，应进行适当的处理，如记录日志、提示用户等
- 避免捕获所有异常，应根据具体情况捕获特定的异常

## 代码检查

### ESLint

- 使用 ESLint 进行代码检查
- 配置 ESLint 规则，确保代码符合规范
- 定期更新 ESLint 规则和插件

### 代码格式化

- 使用 Prettier 进行代码格式化
- 配置 Prettier 规则，确保代码风格统一
- 定期更新 Prettier 规则

## 代码提交

### 提交信息

- 提交信息应简洁明了，能够清晰表达提交的内容
- 提交信息应使用英文，首字母小写
- 提交信息应包含动词和名词，如 "fix: 修复登录页面的表单验证问题"、"feat: 添加用户注册功能"

### 分支管理

### 合并请求

- 合并请求应包含清晰的标题和描述，能够清晰表达合并的内容
- 合并请求应经过代码审查，确保代码符合规范
- 合并请求应经过测试，确保代码没有引入新的 bug
- 合并请求应由项目负责人或指定的代码审查人员进行审查

## 其他

### 代码库管理

- 代码库应使用版本控制系统进行管理，如 Git
- 定期拉取远程代码，保持代码库的同步
- 定期提交代码，确保代码的安全性和可追溯性

### 文档管理

- 代码应包含详细的文档，包括功能说明、使用方法、接口文档等
- 文档应使用 Markdown 格式编写
- 文档应定期更新，确保与代码保持同步