SuperAPI AI 工具集

Naming Variables

通用与其它

查看项目

更新于 10-16 02:35

技能介绍

用途:为变量、函数、类、参数、常量等选择能完整准确描述其所代表实体的名称,并用于审查命名不清的代码。核心观点是变量与其名称本质相同,名称质量即设计质量;命名困难往往是设计问题的信号。

主要能力:给出命名原则——描述“是什么”而非“如何实现”,使用问题域词汇;名称长度以10-16字符为宜,作用域越长名称越具描述性;把 Total、Sum、Average、Max、Min、Count、Index 等限定词放在末尾;使用普通直白的词,避免缩写与含糊词;名称要具体而非通用。还给出约定:集合用复数名,布尔用 is/has/can/should 前缀并避免否定式,常量用 SCREAMING_SNAKE_CASE 或项目统一约定,区分 Count/Total 与 Index,临时变量尽量赋予语义。另附常见反义词对、应避免的名称(x、temp、data、val、foo、单字母等)、一个变量只承担一个用途,以及命名困难对应的设计诊断表。

使用方式:在命名或代码审查时对照清单逐项检查,并按语言惯例调整大小写(Python 用 snake_case,JavaScript/TypeScript 用 camelCase,Go 用 camelCase)。

适用场景:日常编码命名、代码审查、重构可读性差的代码。

限制:资料未提供具体工具、安装命令、收费或平台信息;文中引用的 Code Complete 研究结论与具体数值来自资料原文,未提供更多出处细节。