SuperAPI AI 工具集

clean-code-zh

编程与开发

查看项目

更新于 10-15 22:39

技能介绍

用途:本技能让 AI Agent 按《代码整洁之道》原则编写、审查和重构代码,目标是提升可读性、可维护性与长期生产力。

主要能力:覆盖命名(名副其实、避免误导与模糊区分、可读可搜索)、函数(短小、只做一件事、单一抽象层级、参数尽量少、无副作用、分隔指令与询问)、注释(代码自解释,仅保留法律信息、意图解释、警示、TODO 等)、格式(垂直靠近相关概念、行宽建议 100-120 字符、遵循团队规范)、错误处理(用异常而非返回码、先写 try-catch-finally、不返回也不传递 null)、类设计(单一权责、内聚、对扩展开放对修改关闭)。

使用方式:适用于编写新功能、代码审查、技术债重构和 API 设计。审查清单包括:名称是否表达意图、函数是否超过 20 行、是否混合抽象层级、能否通过重命名消除注释、是否用异常替代错误码、类是否过于庞大而违反 SRP。

限制:资料未提供具体安装命令、调用方式、支持语言或平台信息,暂未提供。