用途:在当前分支或用户指定范围内审查代码改动,按既定标准简化命名、注释与结构,不改变行为,只改动该范围内的代码,并在修改后运行相关既有检查。
主要能力: 命名与用词:变量名、函数名、注释都视为散文,遵循奥威尔《政治与英语》规则——能用短词不用长词,能删则删,能用主动不用被动,能用日常英语就不用外来语、科学词或行话;优先盎格鲁-撒克逊短词(prune、run、watch、stop、drop、walk)而非拉丁词(reconcile、coalesce、normalize)。 命名原则:一词一概念、一概念一词,保持词汇表;上下文已含的词要删(workspaceWatcher 不必写成 startNativeWorkspaceWatcher);复合名常是含糊的托词,如 lastObservedDiskContent 不如 baseline。 注释:用平实英语说明代码无法表达的约束,即非显而易见之处为何存在;复杂实现加注释,含复杂行为或副作用的函数加文档注释;删除叙述对话中变更历史的注释,删除复述自明代码的注释。 结构:文件内采用倒金字塔,先导出或重要函数,辅助函数置后;大文件按概念拆成模块;重叠的类型、函数、常量应合并;优先复用代码库已有的工具函数;可推导的值不要单独传递或存储(如恒等于 editorContent !== baseline 的 isDirty 参数可删)。 过度拟合:代码须独立成立,只对看过本次对话或 PR 的人才有意义的改动属于过度拟合;命名或注释若需对话才能理解,应按代码库自身词汇重写。 未发布代码不做向后兼容:同一分支早期才存在的旧签名、别名或数据形状从未部署,应删除旧路径并更新调用方。
使用方式:在代码准备人工审查时自动触发,也可在编写或审查注释时使用;审查范围为当前分支改动或用户指定范围。
限制:不改变代码行为;只触碰指定范围内的代码;修改后需运行相关既有检查。资料未提供安装命令、平台支持、收费方式等细节。