SuperAPI AI 工具集

flpbalada-naming-cheatsheet

通用与其它

查看项目

更新于 10-16 00:30

技能介绍

用途:为任意编程语言提供变量、函数、类的命名指南,适用于命名新标识符、审查代码命名一致性、重构命名不佳的代码,以及建立团队命名规范。

主要能力:核心原则 S-I-D 要求名称简短(Short)、直观(Intuitive)、描述性(Descriptive)。函数命名采用 A/HC/LC 模式:前缀? + 动作(A) + 高上下文(HC) + 低上下文?(LC),例如 getUser、getUserMessages、handleClickOutside、shouldDisplayMessage;上下文顺序会影响语义,shouldUpdateComponent 表示更新组件,shouldComponentUpdate 表示组件自身更新。

动作动词:get 立即访问数据或用于异步操作;set 声明式赋值;reset 恢复初始值;remove 从集合中移除(与 add 配对),delete 彻底删除(与 create 配对);compose 由已有数据创建新数据;handle 处理动作,常用于回调。

前缀:布尔前缀 is(特征或状态)、has(拥有值或状态)、should(正向条件加动作);边界前缀 min/max(最小/最大值)、prev/next(前/后状态)。

规则:使用英文;统一命名约定(camelCase、PascalCase、snake_case 择一);避免缩写;避免上下文重复(类内方法不必重复类名);名称反映预期结果;正确使用单复数。

限制:资料未提供具体安装命令、平台支持、收费或价格信息;该速查表为规范指南,不绑定特定语言或工具。