SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-15 22:12

技能介绍

用途:面向 TypeScript、JavaScript 与 Node.js 项目的通用编码规范,适用于新建项目或模块、代码质量与可维护性评审、按约定重构、统一命名/格式/结构、配置 lint/格式化/类型检查,以及帮助新成员熟悉编码约定。

主要能力:给出四条代码质量原则——可读性优先、KISS、DRY、YAGNI;TypeScript/JavaScript 规范包括变量命名(描述性名称)、函数命名(动词+名词)、不可变模式(用展开运算符更新对象与数组,避免直接修改)、错误处理(检查 response.ok 并抛出带状态的错误)、异步最佳实践(可并行时用 Promise.all)、类型安全(用接口而非 any);还包括文件组织命名约定(组件 PascalCase、hooks 以 use 前缀 camelCase、工具 camelCase、类型文件 .types 后缀)、注释原则(解释为什么而非是什么、公开 API 用 JSDoc)、测试规范(AAA 结构、描述性测试名)以及代码异味检测(过长函数、深层嵌套、魔法数字)。

使用方式:作为编码约定参考,在新项目、评审、重构、配置工具链和新人引导时对照执行。

限制:资料未提供安装命令、配置项、平台支持范围、收费方式或实际效果数据;具体运行方式与集成步骤暂未提供。