编码标识符缩写建议

[Ray-56]

编码标识符缩写建议

编码标识符也就是通常我们在编码过程中的一些变量、函数或类型的名称

非常需要注意的点，尽量避免生造缩写名

[TOC]

英文单词缩写规则

为了保持代码的简洁，如果表示过长需要缩写。缩写时应该采用统一的缩写规则，避免含糊不清
这样做的目的在于保持命名统一，减少沟通成本，提升团队研发效率

通过观察，发现英文单词的缩写一般采用如下规则：

1. 单词前几个或某几个字母。eg，addr(addres) 和 asm(assemble)
2. 单词音节首字母拼接。eg，msg(message) 和 idx(index)
3. 多个单词首字母拼接。eg，MDN(Mozilla Developer Network)
4. 去掉元音字母 aeiou 保留辅音字母。eg，China 缩写为 CHN，Japan 缩写为 JPN，英尺 foot 缩写为 ft
5. 约定俗称的缩写次。eg，thx(thanks) 和 i18n(internationalization)

缩写示例

时间与日期

a.m.(ante meridiem) = before none
p.m.(post meridiem) = after none
Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec
Mon Tues Wed Thurs Fri Sat Sun
ns.(nasosecond) us.(microsecond) ms.(millisecond) s.(second) h.(hour)

地点

U.S.(United States) U.K.(United Kingdom) E.U.(European Union) U.A.E.(United Arab Emirates)

计量单位

in.(inches) ft.(feet) lbs.(pounds)
mm.(millimeters) cm.(centimeters) m.(meters)
mg.(milligram) g.(gram) kg.(kilogram)

企业职位

GM(General Manager) 总经理
VP(Vice President) 副总裁
FVP(First Vice President) 第一副总裁
AVP(Assistant Vice President) 副总裁助理
CEO(Chief Executive Officer) 首席执行官、总经理、总裁，企业的法人代表
COO(Chief Operations Officer) 首席运营官，类似常务总经理
CFO(Chief Financial Officer) 首席财务官，类型财务总经理
CIO(Chief Information Officer) 首席信息官，主管企业信息的收集和发布
CTO(Chief Technology Officer) 首席技术官，类型总工程师
HRD(Human Resource Director) 人力资源总监
OD(Operations Director) 运营总监
MD(Marketing Director) 市场总监
OM(Operations Manager) 运作经理
PM(Production Manager) 生产经理
PM(Product Manager) 产品经理

拉丁缩略语

e.g. = exempli gratia = for example = 例如
i.e. = id est = that is = 即
etc. = et cetera = and so on = 等等

进制

bin(binary) oct(octonary) dec(decimal) hex(hexadecimal)

常见标识符缩写建议

常见单词缩写

A

Term	Abbreviation	释义
absolute	abs	绝对值
address	addr	地址
administrator	admin	管理员
action	act	动作
algorithm	algo	算法
allocate	alloc	分配
application	app	应用
argument	arg	参数
assemble	asm	汇编
asynchronization	async	异步
attribute	attr	属性
authentication	auth	校验
authentication code	authcode	校验码
average	avg	平均

B

Term	Abbreviation	释义
button	btn	按钮
buffer	buf	缓存

C

Term	Abbreviation	释义
calculate	calc	计算
character	char	字符
change	chg	改变
click	clk	点击
command line interface	cli	命令行接口
context	cont	内容
common	comm	通用
config	conf	配置
column	col	列
command	cmd	命令
communication	comu	通信
compare	cmp	比较
complete	cpl	完成
connect	conn	连接
control	ctrl	控制
coordinates	coord	坐标
copy	cp	拷贝
count	cnt	计数
counter	cter	计数器
current	cur	当前

D

Term	Abbreviation	释义
database	db	数据库
dependency	dep	依赖
debug	dbg	调试
default	def	默认
degree	deg	程度，度数
delay	dly	延迟
delete	del	删除
descriptor	desc	描述符
destination	dst	目的地
dictionary	dict	字典
different	diff	区别
digit	dig	数字
dimension	dim	维度
directory	dir	目录
disable	dis	使失效
display	disp	显示
dialog	dlg	对话
document	doc	文档
double	dbl	两倍
driver	drv	驱动
duplicate	dup	重复
dynamic	dyn	动态

E

Term	Abbreviation	释义
effective	eff	生效的
electric	elec	电子的
execute	exec	执行
executable file	exe	可执行文件
enviroment	env	环境
error	err	错误
enable	en	使生效
engine	eng	引擎
equal	eq	相等的
exception	excep	异常
expand	expa	拓展
experiment	exp	实验
expiration	expi	过期

F

Term	Abbreviation	释义
feature	fea	特征
field	fld	字段
frequency	freq	频率
flag	flg	特征
frame	frm	框架
fractioin	fract	小数
full	ful	全量

G

Term	Abbreviation	释义
greater than	gt	大于
greater equal	ge	大于等于
group	grp	组
generate	gen	产生

H

Term	Abbreviation	释义
horizontal	hori	水平的
handler	hdler	处理着
handle	hdl	处理

I

Term	Abbreviation	释义
increment	inc	增量
increase	incre	增加
ineffective	ineff	未生效的
infomation	info	信息
identifier	id	标识符
index	idx	索引
input	in	输入
image	img	图片
implement	impl	实现
initialization	init	初始化
insert	isrt	插入
instance	ins	实例
interrupt	intr	中断
interval	intv	间隔
invalid	inv	无效的

L

Term	Abbreviation	释义
less than	lt	小于
less equal	le	小于等于
length	len	长度
library	lib	库
limit	lim	限制
lock	lk	上锁
logic	lgc	逻辑的

M

Term	Abbreviation	释义
magnitude	mag	巨大
mailbox	mbox	邮箱
make	mk	做
manager	mgr	管理器
mantissa	mant	尾数
manual	man	手册
manufacturer	mft	制造商
markdown	md	文本标记语言
marshal	mar	序列化
unmarshal	unmar	反序列化
mask	msk	掩码
maximum	max	最大值
middle	mid	中间
minimum	min	最小值
message	msg	消息
memory	mem	内存
multiple	multi	多样的
mutex	mu	互斥锁
measure	meas	测量
multiplex	mul	多路复用

N

Term	Abbreviation	释义
negative	neg	消极的
number	num	数字
neutral	neut	中立
next	nxt	下一个

O

Term	Abbreviation	释义
object	obj	对象
offset	ofs	偏移
optimize	opt	优化
origin	org	起源
organization	organ	组织
output	o	输出
overflow	ovf	溢出

P

Term	Abbreviation	释义
package	pkg	包
password	pass	密码
parameter	param	参数
performance	perf	性能
permutation	permut	排列
permit、permission	perm	许可
picture	pic	图片
point	pt	点
position	pos	位置
power	pwr	电源
pervious	prev	先前的
prefix	pre	前缀
print	prt	打印
priority	prio	优先级
process	proc	进程
product	prod	产品
profile	pf	用户画像
project	proj	项目
program	prog	程序
property	prop	属性
protocal	proto	协议
protect	prot	保护
proxy	prx	代理
public	pub	公共的

Q

Term	Abbreviation	释义
quality	qlty	质量
quarter	quar	四分之一

R

Term	Abbreviation	释义
read	r	读
ready	rdy	就绪
reactive	react	有反应的
recall	rcl	召回
receive	rece	接收
rectangle	rect	长方形
recursion	recu	递归
reference	ref	引用
register	reg	注册
region	rel	发布
repeat	rpt	重复
repository	repo	仓库
request	req	请求
reserve	resv	保留
reset	rst	重复
resource	res	资源
response	rsp	响应
result	rslt	结果
resume	ret	返回
reverse	revs	反转

S

Term	Abbreviation	释义
sample	smp	样本
scale	scal	比例
scan	sca	扫描
schedule	sch	计划
scheduler	scher	调度器
screen	scr	屏幕
search	srch	搜索
second	sec	秒
section	sect	节
segment	seg	段
select	sel	选择
semaphore	sem	信号量
sequence	seq	序列
server	svr	服务
serialize	seri	序列化
signal	sig	信号
source	src	来源
specification	spec	说明
standard	std	标准
statistic	stat	统计
status	sts	状态
storage	stg	存储
strategy	stra	策略
stream	stm	流
subscribe	subs	订阅
subtract	sub	减去
summation	sum	总和
success	succ	成功
suspend	susp	挂起
switch	sw	开关
synchronization	sync	同步
system	sys	系统

T

Term	Abbreviation	释义
table	tbl	表
task	tsk	任务
temporary	tmp	临时的
test	tst	测试
text	txt	文本
threshold	thold	阈值
timestamp	ts	时间戳
timeout	to	超时
toggle	tgl	所有
translate	tran	翻译，转换
trigger	trig	触发器

U

Term	Abbreviation	释义
unknown	unk	未知的
unlock	unlk	解锁
update	upd	更新
upgrade	upg	升级
utility	util	工具

V

Term	Abbreviation	释义
value	v	值
valid	val	有效的
variable	var	变量
version	ver	版本
vertical	vert	垂直的
vector	vect	向量
visible	vis	可见的
voltage	vol	电压

W

Term	Abbreviation	释义
write	w	写
window	win	窗口
welcome	wel	欢迎
width	wid	宽度

后续规划

• repo 存储
• 多端应用提供使用
• VsCode 插件

See Also

• 编码标识符缩写建议
• https://github.com/dablelv/identifier-abbr 各种缩写