SuperAPI AI 工具集

aposd-improving-code-clarity

编程与开发

查看项目

更新于 10-16 09:54

技能介绍

该技能用于提升代码清晰度,核心是“注释先行”与精确命名。

用途:在编写新类、方法或函数时强制注释先行;在改进既有代码时优化命名与文档;适用于从零编写、复制修改、扩展现有函数、改动接口的重构、原型转生产等场景。测试方法、非平凡 lambda、定义行为的配置、含业务逻辑的数据库迁移同样适用。

主要能力:提供注释先行流程——先写类接口注释,再写公共方法签名与注释(空方法体),迭代结构,写实例变量及其注释,最后填充方法体;实现中新增方法或变量时同样先注释。给出注释质量标准(描述抽象、包含非显然细节、用词与代码不同、变量注明单位/边界/null/所有权/不变量)以及接口注释与实现注释的区分。命名部分要求精确与一致,并提供命名评估、精确性检查和一致性检查步骤,附常见命名错误示例。

使用方式:在写任何新代码前先注释、精确命名、一致命名;注释既有代码时避免复述代码,变量用精度注释,方法用直觉注释。遇到难以描述或难以命名时,视为设计问题,应修改设计而非注释。包含反合理化表与紧急绕行标准:仅当生产中断、用户受影响且修复极小时可跳过,并加 TODO 标记并在 24 小时内补文档。

限制:资料未提供具体安装命令、依赖环境、平台信息、收费方式或效果数据,这些暂未提供。