SuperAPI AI 工具集

clean-code

编程与开发

查看项目

更新于 10-16 08:41

技能介绍

用途:这是一个面向 Python 的代码整洁技能,核心是“童子军规则”——每次接触代码时,至少做一处小改进,让模块比接手时更干净。适用于编写、修复、编辑、审查、重构或调试 Python 代码、命名、注释/文档字符串、函数与测试的场景。

主要能力:按工作类型加载对应规则章节。references/full-catalog.md 用于审查任意 Python 代码,是完整规则索引(主目录);references/names.md 用于变量、函数、类、模块命名;references/comments.md 用于编写或编辑注释与文档字符串;references/functions.md 用于创建或重构函数;references/general.md 用于代码质量审查(DRY、意图、抽象);references/tests.md 用于编写或审查测试。规则以编号标识(如 N1、C5、G25、F3、T9)。

使用方式:先完成用户请求的任务,再识别至少一处小的清理机会,应用对应规则章节,并说明所做的改进(例如“同时清理:将 x 重命名为 results 以提升清晰度”)。审查代码时加载完整目录,按规则编号标记违规,建议增量改进而非整体重写。快速改进包括:重命名命名不佳的变量、删除冗余注释、移除死代码或未使用导入、用命名常量替换魔法数字、将深层嵌套块提取为命名良好的函数。时间允许时做更深改进:拆分职责过多的函数、消除重复(DRY)、补充边界检查、提升测试覆盖率。

限制与边界:不要求把每个模块做到完美,只要求比接手时更好;改动应与任务成比例,不做与任务无关的大规模改动;不等待专门的“重构冲刺”;不因“这不是我的代码”而放任。资料未提供具体安装命令、收费方式或平台支持信息。