如何命名优雅的缩写变量名?
只要是编程,就会涉及到变量,好的优雅的变量名不仅能看着舒服,最主要的是能够简单明了的知道这个变量是什么,方便后续的开发校对。
变量名缩写规则通常涉及以下几项原则:
- 简洁明了
变量名应尽量简短,但同时要有意义,能够反映变量的内容或用途。
例如,totalCount 可以缩写为 tCount。
- 去除元音
可以去掉变量名中的元音以缩短长度。
例如,comment 可以缩写为 cmt,total 可以缩写为 ttl。
一个单词超过8个字母的,建议使用缩写。
- 使用驼峰式命名
对于多个单词组成的变量名,采用驼峰式命名法,使每个单词的首字母大写,紧凑在一起。
例如,userName 可以缩写为 uName。
- 避免歧义
即使是缩写,也要确保变量名不易混淆或产生歧义。
例如,maximum 可以缩写为 max,但不要缩写为 m,因为太短且不具备辨识度。
开发常用缩写参照
Identifier(标识符)
identifier -> id
Message(消息)
message -> msg
messages -> msgs
Number(数字)
number -> num
Length(长度)
length -> len
Index(索引)
index -> idx
Count(计数)
count -> cnt
Value(值)
value -> val
Parameter(参数)
parameter -> param
parameters -> params
Temporary(临时)
temporary -> tmp
Configuration(配置)
configuration -> config
configuration -> cfg
Information(信息)
information -> info
Database(数据库)
database -> db
组合词缩减
User Profile(用户资料)
userProfile -> uProf
Session Token(会话令牌)
sessionToken -> sessTok
Transaction ID(交易ID)
transactionID -> transID
Maximum Value(最大值)
maximumValue -> maxVal
Minimum Value(最小值)
minimumValue -> minVal
File Name(文件名)
fileName -> fName
Database Connection(数据库连接)
databaseConnection -> dbConn
Configuration File(配置文件)
configurationFile -> cfgFile
Application Programming Interface(应用程序接口)
applicationProgrammingInterface -> api
Primary Key(主键)
primaryKey -> pk
其他
- 用户信息相关
userName -> uName
userEmail -> uEmail
userPassword -> uPwd
- 文件操作相关
filePath -> fPath
fileSize -> fSize
fileExtension -> fExt
- 时间相关
currentTime -> curTime
- 网络请求相关
requestURL -> reqURL
responseData -> resData
responseCode -> resCode
最后,其实我有时采用的是拼音或拼音缩写,没人笑话吧,呵呵•ᴗ•?