docs(门禁说明): 补充 nested-comment 的触发面口径

本次只改一处中文 Markdown,未触碰 C 源码、头文件与 Keil 工程档案。
因此不跑 @build;提交门禁按文档口径只跑 doc-links 与 pre-commit 命中的钩子。
只暂存这一个 Markdown 文件,让 51 个钩子按 files 与 types 只命中文档相关那几根。
工作区另有两份文档的在飞改动与两份未跟踪脚本,一律不纳入本次提交。
提交正文由 UTF-8 无 BOM 文件承载,经 git commit -F 传入仓库,不走 -m 参数。
原因是 Windows 终端代码页会对命令行参数转码,中文可能变成不可逆的乱码。
正文按每行不超过 80 字符书写(.gitlint 口径),标题不超过 100 字符,中间空行。
正文行不以 # 开头,否则会被默认的注释清理规则删掉;行尾统一 LF 且无尾随空格。
Markdown 改动用精确子串替换落盘,保留文件原有 BOM 状态与行尾,不整文件重写。
落库前后都按字节统计 EF BF BD,结果必须为 0,不信终端与编辑器的渲染结果。
This commit is contained in:
2026-10-28 08:05:21 +08:00
parent 97049a4bf0
commit a583c36a88
+1
View File
@@ -53,6 +53,7 @@
钩子用 `types: [c]`(即 .c/.h),第三方与生成物由配置顶层 exclude 挡掉。
脚本的 `--all` 与钩子喂进来的文件集**刻意同口径**(2026-10-27 实测 403 个文件)——
手跑面与提交面不一致,就会变成「两个数」,本仓已经为这种事返工过好几轮。
纯文档(.md)或纯 Python 的提交不会命中本闸——`types: [c]` 只喂 .c/.h 两类文件,想确认全仓干净就手跑本节的自查命令。
单独自查:`& .venv\Scripts\python.exe scripts/check_nested_comment.py --all`