每一个刻意的速记注释都使用 shortcut: 注释来标记其上限和升级路径(旧代码可能使用 ponytail:)。这会将它们收集到一个账本中,从而使延期不会悄然变为永久性问题。
扫描
在代码仓库中搜索注释标记,跳过 .git 以及 .gitignore 文件忽略的所有内容(依赖项、构建输出、缓存,适用于任何技术栈):
git grep --no-index --exclude-standard -nE '(#|//|/[*]) ?(shortcut|ponytail):' (如果你的技术栈使用其他注释前缀,请添加)
如果用户指定了自己的标记词(如 /ponytail-debt TODO),则搜索该词。
每个匹配项即为账本的一行。注释前缀会将仅提及该约定的文本排除在账本之外。跳过不属于延期标记的匹配项,例如关于键盘快捷键的注释。
输出
每个标记一行,按文件分组:
<文件>:<行号>, <被简化的内容>. 上限: <指定的限制>. 升级: <重新审视的触发条件>.
约定格式为 shortcut: <上限>, <升级路径>,因此直接从上文中提取上限和触发条件。如果希望每行也有责任人?添加 git blame -L<行号>,<行号>。
标记腐化风险:任何没有指定升级路径或触发条件的标记注释都会获得一个 no-trigger 标签,这些注释会悄然腐化。
以 <N> 个标记, <M> 个无触发条件. 结束。未找到时输出:No shortcut debt. Clean ledger.(无速记债务。账本干净。)
边界
仅读取和报告,不修改任何内容。如需持久化,可要求将账本写入文件(例如 PONYTAIL-DEBT.md)。一次性操作。