用途:这是一份与语言、框架无关的代码质量最佳实践指南,用于统一团队编码规范、提升代码可读性与可维护性。
主要能力:以命令形式分主题查阅,包括 /ai-factory.best-practices 总览,以及 naming(命名规范)、structure(代码组织)、errors(错误处理)、testing(测试实践)、review(代码评审清单)五个子主题。
内容要点:命名上要求名称揭示意图、避免缩写,布尔变量用 is/has/can/should 前缀,函数用动词加名词,常量用 SCREAMING_SNAKE_CASE,类用 PascalCase,文件与目录保持单一约定。结构上强调单一职责、函数控制在 20-30 行、参数不超过 3-4 个、纯函数无副作用、按功能而非类型组织模块、通过 index 暴露公共 API、避免循环依赖。错误处理要求定义具体错误类、不吞异常、记录上下文、在系统边界使用错误边界,并给出具体错误信息。测试采用 AAA 模式,一个测试一个断言概念,测试行为而非实现,并给出覆盖优先级。评审部分提供提交前自检与评审者清单,以及反馈写法建议。
使用方式:在支持该技能的环境中按上述命令调用对应主题,作为编码与评审时的参考规范。
限制:资料未说明具体安装方式、支持的平台、收费情况或与特定工具的集成细节,暂未提供。