SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-16 06:13

技能介绍

用途:这是一个跨语言编码规范的权威参考(D9 Canonical Reference),作为唯一事实来源,供各语言审查智能体(如 @typescript-reviewer、@python-reviewer)嵌入使用,审查时可引用“See also: /coding-standards”。

主要能力:

  1. 命名约定:给出 TypeScript/JavaScript、Python、Go、Rust、Java、C#、Swift 的变量、函数、常量命名规则;类/类型/接口统一用 PascalCase;布尔值用 is/has/can/should 前缀;集合用复数名词。避免单字母变量(循环计数器 i/j/k 除外)、少于3字符的缩写、冗余类型名。
  2. 函数设计:最大50行(超80行必须拆分)、单一职责、最多3个参数(超出用配置对象)、圈复杂度≤10(超15必须重构)、嵌套≤3层,推荐早返回模式。
  3. 错误处理:禁止静默吞掉错误;错误消息须含上下文;传播或处理二选一;TypeScript 用类型化错误;Python 禁止裸 except;Go 检查返回错误并用 errors.Is/As;Rust 用 ? 传播,库代码不用 unwrap。
  4. 代码结构:不可变优先(const/val/final、readonly);禁止魔法数字,用常量替代;禁止注释掉的代码。
  5. 反模式清单:含可变全局状态、未 await 的 Promise、TypeScript 的 any、God Object 等,并标注严重级别与原因。
  6. SOLID 检查清单:单一职责、开闭、里氏替换、接口隔离、依赖倒置。

使用方式:作为共享规则被审查智能体引用,用于代码审查与规范校验。

限制:资料未提供安装命令、具体平台支持范围与适用场景细节。