SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-28 16:10

技能介绍

用途 该技能作为代码工作的基线质量策略,跨语言适用,是语言/框架专用技能的补充。适用于新代码生成、代码编辑与重构、代码评审响应,以及对触及区域进行文档和格式规范化。

主要能力 提供设计模式与实现原则、格式化与对齐策略、文档标准与文件结构、重构工作流,以及注释标签保留与文档生成策略等参考规范。要求在纵向分隔块中强制对齐分隔符列(key : value),而非对齐值列。

使用方式 按需加载参考文档:references/design-patterns.md 用于架构和实现原则;references/formatting-alignment.md 用于对齐策略和格式护栏;references/documentation-structure-refactoring.md 用于文档标准、文件结构和重构流程;references/important-tags-and-doc-generation.md 用于强制注释标签保留和文档生成策略。核心工作流为:检查任务范围和涉及文件;对非简单工作提出至少两种实现方案并给出简要优缺点;选择保留行为和约束的最简方案;仅在触及的逻辑块应用格式、文档和结构规则;验证行为并解释有意例外。

输出要求与完成检查 生成或修改代码时需包含主要实现选择的简短优缺点,保持方案简单、避免过度设计,除非明确要求否则保留现有行为,并指出有意保留的技术债务或推迟的清理。完成检查包括:设计保持简单(KISS/DRY/YAGNI/单一职责)、触及块遵循对齐与可读性护栏、冒号分隔的纵向块分隔符保持在一列、非显而易见逻辑用简洁的“为什么”注释说明、文件结构保持连贯可预测、重构保留行为并提升清晰度、遵守特殊注释标签和 AGENT_TODO 处理策略。

适用场景与限制 适用于跨语言代码质量治理及与具体语言技能协同的场景。该技能与语言/框架技能冲突时,以语法、运行时和框架正确性为主要约束,格式和文档规则仅在不冲突处应用。其他细节暂未提供。