Abbreviation命名缩写

变量和命名缩写首先是为了提高开发者编程效率,其次是为了使用者方便记忆和快速使用,最后是为了压缩文件大小,不过最终使用框架代码的时候通常会使用min版本,这类版本已经不在乎短命名带来的文件尺寸变化;变量和命名缩写都是采用国际通行的、可读的方式进行,但是有些时候为了方便统一管理而自创了部分缩写,这类缩写主要体现在css变量当中,例如_c-prim-tl,其完整的意思是color+primary+translucent即半透明主色,其中translucent在英文编程界没有缩写,所以自创以tl作为缩写。

前言

在本框架的css和js文件当中有许多缩写,这些缩写基本上都有迹可循,有的是英语环境中常见的缩写形式,比如primary简写为prim;有的缩写是因为英文单词很长,但在英文中没对照的缩写,不得不手动造得来,例如translucent简写为tl

使用缩写的意义如下:

  • 提高开发者编码效率。有时候英文不好的开发者需要时常翻看api文档寻找想要的属性名或样式名,这样子比较耽误时间;通过使用简写形式,开发者只需要记住单词某部分即可快速使用该属性。
  • 减少压缩文件比特值。js文件mini化可以自动简化命名,但是css文件却不可以简化命名,所以通过属性简写是能很大程度上压缩css文件的。

本页面列举本框架的常见缩写单词。


常规缩写

缩写 原词 意义 说明
prim primary 主要的
succ success 成功的
warn warning 警告
info information 信息
buf buffer 缓冲
load loading 加载
btn button 按钮
nav navigation 导航
obs observer/observe 监听
opts options 参数/选项
opt option 参数/选项
str string 字符串
arr array 数组
obj object 对象
cumb breadcrumb 面包屑导航
ins instancce 实例
stor storage 存储 组合缩写:storName、storKeys
ell ellipsis 省略
tpl template 模板
wrap wrapper 容器
bd border 边框
bg background 背景
bc background-color 背景色
grad gradient 渐变
sd shadow 阴影
br break 中断/隔开
txt text 文本
msg message 消息
pop popup 气泡/窗口
valid validate 校验
cont content 内容
req request 请求
cmpt component 组件
mod module 模块
lt light 轻便简约 通常与dk成对出现
tmp/temp temporary 临时文件/临时的
dp deppen 加深
gy grey 灰色
dk dark 黑色 通常与lt成对出现
pos position 定位
cb callback 回调
el element 元素
idx index 索引
num number 数字
evt event 事件
fn function 函数
dir direction 方向
v vertical 垂直的 常与h同时出现
h horizonal/height 水平的/高度 常与v同时出现
w width 宽度 常与h同时出现
crude create + read + update + delete 增删改查
err error 错误
ctx context 上下文
val value
lbl label 标签 通常与val成对出现
arg argument 参数
args arguments 参数复数
hdr header 头部
ftr footer 底部
sec section 板块
disp display 展示/呈现
auth authorization 授权
intl/i18n internationalization 国际化
col column 列/栏目
conn connect 连接
cfg configuration 确认
dist distribution 分发
lib library 库/仓库
doc documentation 文档
a11y accessibility 残障优化
b4 before 在...之前 以音代意
2 to 转成/转到 以音代意,通常组合使用
l8r later 以后 以音代意
ver version 版本

原创缩写

缩写 原词 意义 说明
ing xxxing 进行中 例如:live、living、lived
ed xxxed 已完成 例如:live、living、lived
fc focus 聚焦 原创
ht halftone 半调色 原创
aj adjacent 相似色 原创
sg sunglass 太阳镜透明 原创
ct contrast 对比色 原创
tp translparent 全透明 原创
tl translucent 半透明 原创
ac acylic 亚克力透明 原创
fg frosted glass 毛玻璃 原创