SuperAPI AI 工具集

naming-cheatsheet

前端与建站

查看项目

更新于 10-16 05:47

技能介绍

用途:帮助开发者在编写或审查代码时,为变量、函数、布尔值、类、文件、模块、React Hooks 和事件处理器等标识符起出清晰、一致、易读的名称,减少歧义。

主要能力:提供命名规则与模式。规则包括使用英文、遵循项目约定、避免缩写与生造词、避免重复上下文、单复数与值形态匹配、布尔值按预期真值命名、React 的 use 前缀仅保留给 Hooks。函数命名模式为:前缀? + 动作 + 高上下文 + 低上下文?,示例有 getUser、getUserMessages、handleClickOutside、shouldDisplayMessage。动作词表:get 读取或获取数据,set 赋下一个值,reset 恢复初始状态,add/remove 集合变更,create/delete 实体生命周期,compose/build 由值构造值,handle 响应事件。布尔前缀:is 表示状态(isActive),has 表示拥有(hasItems),should 表示条件加动作(shouldRender),can 表示能力(canEdit)。React 与错误处理:useX 仅用于 Hooks,事件处理器用 handleX,props 回调用 onX,工厂函数需带动词如 createErrorResult;error 指 Error 实例,errorMessage 指字符串,errors 指列表。

使用方式:在命名或审查标识符时套用上述规则与模式,并按输出格式给出命名审查结果,包含 Identifier(当前名称)、Issue(不清晰/不一致/过宽/形态错误)、Better name(更佳名称)、Reason(原因)、Pattern(动作/上下文/布尔/边界)。

适用场景:代码编写、代码审查、重构命名、团队统一命名约定。

限制:资料未提供具体安装命令、平台支持、收费方式或自动化集成细节,暂未提供。