SuperAPI AI 工具集

code-prose

编程与开发

查看项目

更新于 10-16 05:07

技能介绍

用途:审查当前分支或用户指定范围内的改动,只在该范围内修改代码,并在修改后运行相关既有检查,全程不改变代码行为。

主要能力:对变量名、函数名和注释应用奥威尔规则——能用短词就不用长词;能删的词就删;能用主动语态就不用被动;能用日常英语表达就不用外来语、科学词或行话。倾向盎格鲁-撒克逊短词(prune、run、watch、stop、drop、walk),少用拉丁词源抽象词(reconcile、coalesce、normalize、reconciliation)。命名上要求一词一概念、一概念一词,保持词汇表一致;删掉上下文已承载的词,如 workspaceWatcher 内不必再写 startNativeWorkspaceWatcher;复合名往往是含糊的托词,如 lastObservedDiskContent 不如 baseline 直白。注释只写代码无法表达的约束,即非显而易见之处存在的原因;复杂实现或含副作用的行为加文档注释;叙述对话历史的注释、复述自明行为的注释应删除。

使用方式:在指定范围内审查改动并应用上述标准,改完运行相关既有检查。资料未提供具体安装命令或调用方式。

适用场景:命名、用词或注释需要精简与统一时;需要让代码对没有上下文的读者可读时。

限制:不得改变行为;只处理指定范围;过度拟合的命名或注释(只有看过本次对话或 PR 的人才懂)需按代码库自身词汇重写。结构层面的同类工作(文件形态、可推导状态、与从未发布的代码的兼容性)应使用 refactoring。