SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-15 23:47

技能介绍

用途:为跨项目开发提供统一的编码标准与最佳实践,适用于 TypeScript、JavaScript、React 和 Node.js 项目,帮助团队保持代码可读、可维护与可重构。

主要能力:

  • 代码质量原则:可读性优先、KISS、DRY、YAGNI。
  • 命名规范:变量使用描述性名称,函数采用动词-名词模式。
  • 不可变性:始终使用展开运算符,禁止直接修改对象或数组。
  • 错误处理:使用 try/catch 并检查 response.ok,抛出明确错误。
  • 异步实践:能用 Promise.all 并行执行时避免顺序 await。
  • 类型安全:定义 interface,避免使用 any。
  • React:函数组件加类型、自定义 Hooks、函数式状态更新、清晰的条件渲染。
  • API 设计:REST 约定、统一响应结构、使用 zod 做输入校验。
  • 文件组织与命名:给出目录结构与 PascalCase/camelCase 约定。
  • 注释与 JSDoc:解释 WHY 而非 WHAT,公共 API 写 JSDoc。
  • 性能:useMemo、useCallback、lazy/Suspense、只查询所需列。
  • 测试:AAA 结构与描述性测试名。
  • 代码坏味道:长函数、深层嵌套、魔法数字。

使用方式:作为项目或团队的编码规范参考,在开发与代码评审中对照执行。资料未提供安装命令或具体集成步骤。

适用场景:TypeScript/JavaScript/React/Node.js 项目的日常开发、代码评审与重构。

限制:资料未说明收费、价格、平台支持范围或实际效果;内容为规范建议,非可执行工具。