这些缩写在各类程序中都很常见,可以说是“基本缩写”,无论是控制变量、计数器或临时变量中经常能见到:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
tmp | temporary | 临时变量,比如:tmp , tmpVal 表示短暂存储数据 |
val | value | 数据的值,如:curVal 、newVal |
var | variable | 变量,一般作为占位符用法较少 |
idx | index | 索引,通常用于循环或数组下标,如:iIdx 或startIdx |
cnt | count | 数量计数器,如:errCnt (错误计数)、itemCnt |
num | number | 数值或数量,如:totalNum 、numOfItems |
在涉及数字、计数或数值运算的变量中,这些缩写比较常用:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
min | minimum | 最小值,如:minVal |
max | maximum | 最大值,如:maxVal |
avg | average | 平均数,如:avgScore |
sum | sum | 求和,如:totalSum 或sumVal |
diff | difference | 差值,常用在数学运算中,如:diffVal |
prec | precision | 精度,常用于数值计算的精度控制 |
字符串以及文本常用缩写常见于处理名称、信息展示时:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
str | string | 字符串,如:userStr 、msgStr |
txt | text | 文本,如:errorTxt 、inputTxt |
buf | buffer | 缓冲区,用于临时存储字符串数据,如:strBuf |
chr | character | 单个字符,如:curChr |
程序中经常处理数组、列表、字典、集合等结构,常见缩写如下:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
arr | array | 数组,如:numArr 、dataArr |
lst | list | 列表,如:itemLst |
dict | dictionary/dict | 字典,如:userDict ,有时也用 map 表示映射结构 |
set | set | 集合,如:itemSet |
tbl | table | 数据表或二维数据结构,如:lookupTbl |
对于函数、方法、回调等,以下缩写较为常见:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
func | function | 函数、方法,如:calcFunc 、updateFunc |
cb | callback | 回调函数,如:onClickCb 、doneCb |
param | parameter | 参数,如:initParam 、configParam |
arg | argument | 参数,类似于 param,有时用于函数传参命名,如:arg1 |
ret | return | 返回值,如:retVal |
调试信息、错误码、状态码在程序中也经常需要用缩写描述:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
err | error | 错误,如:errMsg 、lastErr |
stat | status | 状态,如:currStat 、netStat |
flag | flag/标识 | 标志变量,用于条件判断,如:isActiveFlag |
dbg | debug | 调试信息,如:dbgInfo 、dbgMode |
在文件操作中常用的缩写:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
cfg | configuration | 配置信息,如:appCfg 、dbCfg |
file | file | 文件,如:inputFile 、logFile |
dir | directory | 目录,如:baseDir 、tempDir |
path | path | 路径,如:filePath 、imgPath |
buf | buffer | 文件缓冲区,有时也用 buf 表示 |
处理时间或日期信息时常用:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
dt | date/time | 日期或时间,如:startDt 、endDt |
ts | timestamp | 时间戳,如:createTs 、updateTs |
tm | time | 时间,如:currTm |
在网络编程中,这些缩写也是常见的:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
addr | address | 地址,如:serverAddr 、ipAddr |
ip | IP address | IP 地址,如:clientIp |
port | port | 端口,如:serverPort 、localPort |
req | request | 请求,如:httpReq 、reqData |
resp | response | 响应,如:httpResp 、respData |
在前端或 GUI 开发中,组件常用的缩写:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
btn | button | 按钮,如:submitBtn 、cancelBtn |
img | image | 图片,如:logoImg 、avatarImg |
lbl | label | 标签,如:nameLbl 、statusLbl |
chk | checkbox | 复选框,如:agreeChk |
frm | form | 表单,如:loginFrm |
根据项目具体需求,还会遇到一些特定领域的缩写,以下为部分常见其它缩写:
缩写 | 全称 | 说明及使用示例 |
---|---|---|
cfg | configuration | 同“配置”,见文件相关 |
env | environment | 环境变量,如:prodEnv 、devEnv |
res | result/resource | 结果、资源,如:queryRes 、fileRes |
meta | metadata | 元数据,如:userMeta 、dataMeta |
inst | instance | 实例,如:dbInst 、objInst |
obj | object | 对象,如:currObj |
rec | record | 记录,如:userRec 、logRec |
cfg | config/configure | 配置,有时也写作 cfg 或 config |
auth | authentication | 身份验证,如:userAuth 、authToken |
proc | process/processes | 进程或处理,如:currProc 、procTime |
保持一致性
无论采用何种缩写方式,都应在整个项目中保持命名的一致性。
例如:全局统一用 cnt
表示计数器,避免部分地方使用 count
、部分地方使用 cnt
。
注意可读性
缩写应能让团队成员快速理解变量代表的意义。对于不常见的缩写,建议在注释中补充说明。
例如:cfg
很常见,但在少数团队中可能不直观,可适当注释为“configuration”。
避免过度缩写
当缩写过多或过于模糊时,可能会影响代码的可维护性。
例如:d
作为变量名容易引起歧义,最好使用 date
或 dt
。
遵循团队和语言规范
不同的编程语言和团队可能有特定的命名规范,请参考相应的编码标准。
例如:某些语言提倡使用全称,而另一些语言(如 C/C++ 中的许多老旧项目)可能更习惯于缩写。
以上内容覆盖了变量命名中较为常见的几大类:通用、数值、字符串、数据结构、函数、错误、文件、时间、网络以及图形界面等。
在实际编程过程中,根据项目的具体上下文和团队规范挑选合适的缩写组合,即可有效提高代码的书写效率,同时保证代码的可读性和维护性。
这份整理仅为参考,主要是个人开发的时候做文档进行查看
转载吱一声~