docs: 注释规范要求精简可读,并清理生产代码中的历史叙事
AGENTS.md 的注释规范新增三节可执行约束:
- 只写代码真实逻辑:注释只回答"做什么"与"为什么必须这么做",禁止写决策/
修改时间、历史版本对比、实测数据与实验结论、事故与缺陷编号(run_xxxx /
batch_xxxx / R01 等)——这些属 docs/decisions.md 与审查跟踪文件;当前生效
的约束可以写,但不附带它何时因何变成这样。
- 精简可读:单段连续注释不超过 3 行;docstring 一句话概括职责,不重复函数名
已表达的信息;不写逐行翻译代码的废话注释,只在非显然处(业务规则、边界、
易错点、外部约束)加注。
- 覆盖范围:测试注释只说明验证什么行为,回归用例可保留一句溯源;并明确
参数说明应写在**参数读取处**附近,而不是把多个参数的解释堆在离使用位置
很远的注释块里。
按此清理生产代码(注释净减 70 行,18 个文件),典型处理:
- nodes/whisper.py:删掉堆在一起、含"用户 2026-08 决定 / 实测 savr-1054"
等叙事的参数块,把各参数说明移到各自的读取处与 model.transcribe 调用处;
- nodes/llm_filter.py、nodes/subtitle_cleanup.py:模块 docstring 去掉英文
背景叙事与条数统计,保留"默认只跑规则层""整条删除而非 '-' 占位"等当前
行为;
- src/wov_app/{batch,db,scheduler}.py 与 routers:去掉 batch_xxx/run_xxx 事故
编号与"修复前……"对比,改为一句"否则会出现什么问题";
- nodes/ass.py、frame_extract.py:去掉废弃值对比与日期,保留判据本身。
安全验证:用 AST 对比(剥离 docstring 后比较语法树)确认 18 个文件**零逻辑
变更**;`nodes/proper_nouns.py` 的规则表 reason 字段会注入 LLM 提示词,属于
数据而非注释,已恢复原值。全量测试 476 passed。
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
"""每视频自适应 VAD 调参(信号分析 + 片段网格验证)。
|
||||
|
||||
背景(实测 CJOD-255):全程 BGM 覆盖的视频几乎没有纯静音,固定 VAD
|
||||
参数会把音乐当语音,导致 whisper 全段解码 → 碎片化(80%)、漏句(32%)、
|
||||
敏感段丢失。不同视频声学差异大,需**每视频独立分析后再定 VAD 参数**。
|
||||
背景:全程 BGM 覆盖的视频几乎没有纯静音,固定 VAD 参数会把音乐当语音,
|
||||
导致 whisper 全段解码、字幕碎片化并漏句。不同视频声学差异大,需**每视频
|
||||
独立分析后再定 VAD 参数**。
|
||||
|
||||
方案(用户确认):
|
||||
方案:
|
||||
1. 信号分析(秒级,无模型)缩窄参数空间:1s 能量分布 → 静音比例、
|
||||
BGM 底噪、语音疏密,推出 threshold/min_silence/speech_pad 候选;
|
||||
2. 片段小网格验证(90s 代表片段,3~5 组参数跑 whisper):
|
||||
|
||||
Reference in New Issue
Block a user