新增代码规范检查钩子（规范V1.0 可机械校验项）并修复存量违规
新增 scripts/check_coding_standard.py + coding-standard 钩子（S1~S9： 头文件保护宏、文件头注释、宏大写、_t 后缀、switch default、 禁 strcpy/sprintf/goto/Tab、函数注释） 修复存量违规：NET_* 字节序宏大写化、net_fd_set 等类型加 _t 后缀、 net_inet_ntoa 的 sprintf 改 snprintf、补 4 处函数注释与 ui_task.c 文件头 docs/代码规范/pre-commit使用说明.md：新增 2.8 节，修正失效文档路径
This commit is contained in:
@@ -216,20 +216,3 @@ if (day_count < diy) break;
|
||||
某条规则在整个工程中都是噪音/不适用时，在 `.pre-commit-config.yaml` 的 args 中添加 `--suppress=规则名`（同样遵守 4.2 节引号规则），现有清单见 4.1 节。
|
||||
|
||||
---
|
||||
|
||||
## 6. 问题与误报处理记录
|
||||
|
||||
### style 检查发现的问题（已处理完毕）
|
||||
|
||||
开启 style 后发现的有价值问题已全部处理：
|
||||
|
||||
| 规则 | 问题 | 涉及文件 | 处理结果 |
|
||||
|---|---|---|---|
|
||||
| `compareValueOutOfTypeRangeError` | `uint16_t > 65535` 恒假 | net_socket.c | ✅ 已修复（改为 `== 0` 检测溢出绕回） |
|
||||
| `redundantAssignment` | 重复赋值覆盖旧值 | ch395f.c | ✅ 已抑制（HAL 清标志宏读寄存器即目的，误报） |
|
||||
| `unreadVariable` | 变量赋值后未读取 | gd5f2gq5ue.c, time_sync.c, ringbuf.c | ✅ 已修复（移除冗余初始化） |
|
||||
| `variableScope` | 变量作用域可缩小 | sys_clock.c, net_socket.c 等 18 处 | ✅ 已修复（声明移入实际使用块） |
|
||||
| `constVariablePointer` | 指针可加 const 防误改 | net_select.c, net_socket.c 共 6 处 | ✅ 已修复（`p_sock` 改为 `const net_sock_t *`） |
|
||||
| `knownConditionTrueFalse` | `day_count < diy` 被判恒假（闰年 `diy=366` 分支未跟踪，误报） | sys_clock.c:108 | ✅ 已行内抑制（`// cppcheck-suppress`） |
|
||||
|
||||
> 注：`knownConditionTrueFalse` 属真误报——闰年分支 `diy=366` 时 `day_count==365` 的 break 有意义，cppcheck 数据流分析未覆盖该分支。已用行内抑制处理，不影响该规则在其他文件上的正常检查。
|
||||
|
||||
@@ -15,8 +15,9 @@ git commit
|
||||
├─ check-added-large-files 阻止 >1MB 大文件
|
||||
├─ check-merge-conflict 阻止含冲突标记的文件
|
||||
├─ check-yaml 校验 YAML 语法
|
||||
├─ cppcheck C 静态分析（自有代码）
|
||||
└─ no-mojibake 阻止 U+FFFD 乱码文件
|
||||
├─ cppcheck C 静态分析（自有代码）
|
||||
├─ no-mojibake 阻止 U+FFFD 乱码文件
|
||||
└─ coding-standard C 代码规范检查（规范V1.0 可机械校验项）
|
||||
└─ commit-msg（.git/hooks/commit-msg）
|
||||
└─ gitlint 校验 commit message 格式
|
||||
```
|
||||
@@ -30,6 +31,7 @@ git commit
|
||||
| pre-commit 4.6.2 | `uv tool install pre-commit` | 钩子框架 |
|
||||
| cppcheck 2.21.0 | `winget install cppcheck` | C 静态分析引擎 |
|
||||
| scripts/check_mojibake.py | 随仓库提交 | U+FFFD 乱码检测（纯 Python，无依赖） |
|
||||
| scripts/check_coding_standard.py | 随仓库提交 | 代码规范检查（纯 Python，无依赖） |
|
||||
|
||||
> **PATH 要求**：cppcheck 安装后需在系统 PATH 中（`C:\Program Files\Cppcheck`）。winget 自动写入 User PATH，但当前终端不会立即生效，需**重开终端**。
|
||||
|
||||
@@ -96,7 +98,7 @@ cppcheck 是开源 C/C++ 静态分析工具，**不运行代码**，通过语法
|
||||
| **典型报错** | `[path/to/file.c:123]: (style) variableScope The scope of the variable ... can be reduced` |
|
||||
| **增量速度** | 单文件约 1~2 秒；全库约 5 秒 |
|
||||
|
||||
> **完整规则清单（style 类别 95 项详解）、配置参数、YAML 引号陷阱、误报抑制方法、历史问题处理记录见 `docs/cppcheck使用说明.md`。**
|
||||
> **完整规则清单（style 类别 95 项详解）、配置参数、YAML 引号陷阱、误报抑制方法见 `docs/代码规范/cppcheck使用说明.md`。**
|
||||
|
||||
### 2.7 no-mojibake — U+FFFD 乱码拦截
|
||||
|
||||
@@ -110,7 +112,35 @@ cppcheck 是开源 C/C++ 静态分析工具，**不运行代码**，通过语法
|
||||
|
||||
> ⚠️ **编码铁律**：U+FFFD 是不可逆损坏（无法从替换符反推原始中文字符）。若发现新文件出现 U+FFFD，必须排查写入方式（禁用 Get-Content / Set-Content 重写中文文件）。
|
||||
|
||||
### 2.8 gitlint — Commit Message 格式
|
||||
### 2.8 coding-standard — C 代码规范检查
|
||||
|
||||
依据 `docs/代码规范/嵌入式C语言代码规范（V1.0）.md`，用 `scripts/check_coding_standard.py` 对**可机械化校验**的规则做提交前拦截（纯 Python 正则扫描，无依赖）。
|
||||
|
||||
| 项 | 说明 |
|
||||
|---|---|
|
||||
| **触发条件** | 自有代码 .c/.h 文件（App/、Drivers/BSP/，第三方与 CubeMX 生成文件除外）违反下列规则 |
|
||||
| **处理方式** | **阻止提交**（必须修复） |
|
||||
| **典型报错** | `L123 [S3 3.4.1] 宏名须全大写+下划线: net_htonl` |
|
||||
|
||||
**检查项（S 编号与脚本输出一致）**：
|
||||
|
||||
| 编号 | 规范条款 | 规则 |
|
||||
|---|---|---|
|
||||
| S1 | 2.3.1 | .h 文件必须有 `__XXX_H` 格式头文件保护宏 |
|
||||
| S2 | 5.2 | 文件开头必须有文件头注释（含 模块名称/作者） |
|
||||
| S3 | 3.4.1 | `#define` 宏名必须全大写+下划线+数字 |
|
||||
| S4 | 3.5.1 | typedef 类型名必须以 `_t` 结尾 |
|
||||
| S5 | 6.3.2 | switch 必须包含 default 分支 |
|
||||
| S6 | 7.5 | 禁用 strcpy/strcat/sprintf/gets（改用 strncpy/strncat/snprintf） |
|
||||
| S7 | 6.3.3 | 禁止 goto |
|
||||
| S8 | 4.1.1 | 禁止 Tab 缩进（4 空格） |
|
||||
| S9 | 5.3 | 函数定义必须有函数注释（含「函数功能」） |
|
||||
|
||||
**不在检查范围**（语义类规则，无法机械可靠判定）：函数长度/单一职责、参数数量、错误处理、递归、注释掉的代码等，仍需人工评审把关。
|
||||
|
||||
**排除文件**（与 cppcheck 钩子范围一致，另加）：`Src/`、`Inc/`（CubeMX 生成，重新生成即覆盖）、`Drivers/BSP/GD5F2GQ5UE/nand_ftl.*`（dhara/FatFS 接口适配层，函数名由外部 API 固定）。
|
||||
|
||||
### 2.9 gitlint — Commit Message 格式
|
||||
|
||||
| 项 | 说明 |
|
||||
|---|---|
|
||||
@@ -150,6 +180,7 @@ git commit -m "修复网络超时重连逻辑"
|
||||
| end-of-file-fixer | 同上 | 同上 |
|
||||
| cppcheck | 报 warning/performance/portability/style | 根据报告修复代码；误报用行内抑制或 `--suppress`（详见 `docs/cppcheck使用说明.md`）|
|
||||
| no-mojibake | `U+FFFD replacement chars found` | 从 git 历史恢复干净版本（不可逆！） |
|
||||
| coding-standard | `L行号 [Sx x.x.x] 规则说明` | 按违规项修复（命名加前缀/大写化、补函数注释、sprintf 改 snprintf 等） |
|
||||
| gitlint | `Title exceeds max length` | 精简 commit message 标题 |
|
||||
|
||||
### 3.3 全库扫描（配置变更后）
|
||||
@@ -232,12 +263,13 @@ $env:PATH = [Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [Env
|
||||
|
||||
| 文件 | 位置 | 说明 |
|
||||
|---|---|---|
|
||||
| `.pre-commit-config.yaml` | 仓库根 | 钩子配置（7 个钩子 + 1 个预留） |
|
||||
| `.pre-commit-config.yaml` | 仓库根 | 钩子配置（8 个钩子 + 1 个预留） |
|
||||
| `.gitlint` | 仓库根 | gitlint 规则（宽松，兼容中文） |
|
||||
| `scripts/check_mojibake.py` | scripts/ | U+FFFD 检测脚本 |
|
||||
| `docs/自动化代码审查实施.md` | docs/ | 实施规划文档（Route A/B 设计） |
|
||||
| `docs/cppcheck使用说明.md` | docs/ | cppcheck 钩子详解（规则/配置/抑制） |
|
||||
| `docs/pre-commit使用说明.md` | 本文档 | 部署与使用说明 |
|
||||
| `scripts/check_coding_standard.py` | scripts/ | 代码规范检查脚本（规范 V1.0 可机械校验项） |
|
||||
| `docs/代码规范/嵌入式C语言代码规范（V1.0）.md` | docs/代码规范/ | 代码规范原文（S1~S9 规则来源） |
|
||||
| `docs/代码规范/cppcheck使用说明.md` | docs/代码规范/ | cppcheck 钩子详解（规则/配置/抑制） |
|
||||
| `docs/代码规范/pre-commit使用说明.md` | 本文档 | 部署与使用说明 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user