SuperAPI AI 工具集

the-art-of-naming

编程与开发

查看项目

更新于 10-15 21:08

技能介绍

用途:为 TypeScript 与 Angular 项目提供结构化命名方法论,让代码自解释、一致且易读。适用于命名新变量/函数/类/接口/类型、审查命名一致性、重构提升可读性、为新项目配置 lint 规则,以及帮助新成员熟悉代码库约定。

主要能力(按优先级):1) 大小写约定(关键):变量与函数用 camelCase,类/枚举/类型用 PascalCase,导出常量用 UPPER_CASE。2) S-I-D 与禁用缩写(关键):名称须 Short、Intuitive、Descriptive,禁止缩写,如 onItemClick 而非 onItmClk。3) 前缀约定(高):接口用 I,私有成员用 _,泛型用 T/R/U/V/K。4) 布尔命名(高):以 is/has/should/can 开头并保持正向语义。5) 上下文去重(高):成员名不重复类/组件名,如 MenuItem.handleClick() 而非 MenuItem.handleMenuItemClick()。6) 函数命名(高):A/HC/LC 模式与正确动词,get(同步)、fetch(异步)、remove(集合)、delete(永久)、compose、handle。7) 变量命名(中):P/HC/LC 模式,形成结构化、可预测的名称。

使用方式:按规则文件查阅详细说明与代码示例,包括 rules/naming-casing-convention.md、rules/naming-sid.md、rules/naming-prefix-convention.md、rules/naming-boolean.md、rules/naming-context-duplication.md、rules/naming-function-pattern.md、rules/naming-variable-pattern.md。每个规则文件含重要性说明、错误示例及解释、正确示例及解释、汇总表与参考。完整合并文档见 AGENTS.md。

限制:资料未提供具体安装命令、依赖、平台支持、收费或价格信息,暂未提供。