SuperAPI AI 工具集

code-conventions

编程与开发

查看项目

更新于 10-15 23:33

技能介绍

用途:在任意语言或技术栈中编写、生成或评审代码时,提供跨项目的通用质量原则,统一命名、文件结构、组织方式与质量约定;技术栈专属规范由各自的技能负责。

主要能力:命名规范(变量/函数 camelCase,类/组件 PascalCase,常量 UPPER_SNAKE_CASE,非组件文件 kebab-case,组件文件 PascalCase;布尔值用 is/has/should 前缀,回调用 handle/on 前缀;缩写按单词处理);每个文件单一职责;禁止死代码(未用导入、未用变量、注释掉的代码、return 后不可达代码);避免变量遮蔽;DRY,发现两处以上重复逻辑应抽取;默认安全(外部输入不得拼接进查询或 shell 命令,使用参数化查询;不得硬编码密钥,改用环境变量;改动状态的接口需要鉴权检查;在系统边界验证外部输入);健壮性(入口处守卫、快速失败,不静默吞异常,异常需带上下文记录并重新抛出,用提前返回替代深层嵌套);YAGNI,只实现当下有真实用例的功能,避免为假设的未来做抽象或配置。

使用方式:作为技能在写代码或评审时触发。资料未提供安装命令、调用命令或具体接入步骤。

适用场景:新写函数、类或模块,代码评审,建立跨项目标准,任意技术栈的命名与结构决策。

限制:不适用于 TypeScript 专属模式、框架专属模式、可访问性、架构决策以及 lint/格式化工具,这些应使用对应技能。资料未提供具体收费、价格、平台与效果信息。