引言
今天来聊聊命名相关内容。
在日常工作中,项目、类、方法、表等等等等,都需要我们起名来标识区分。好的名字让人赏心悦目,不好的名字让人看的想吐。
最近工作有幸写了node、前端、php、sql、scala,也见识了公司各位前辈们的命名功底。其中不乏abc命名、拼音命名、蹩脚英文命名,更有不少从别的地方粘过来连名都不改的操作。
命名没有对错,只是规范一点,可以提高可读性、可维护性。
命名原则
拼写正确
拼写正确是可读的基础。
play shift
和play shit
自己体会一下
清新明了,见名知意
根据要表达的内容命名,一针见血。
getNameById 根据id获取名称
ClassLoader 类加载器
MYSQL_USERNAME mysql用户名
如上几个例子,我们一眼就知道要表达什么,可读性高。
使用英文字母命名
在编程中,英文还是较为主流的,最好使用单词来命名,再不济也是用拼音来命名。
不论是拼音或单词,清晰表意是首要。
保持一致
在一个项目中,应该使用统一的规范来命名。
无规矩不成方圆。
合理使用动词名词
类名、变量名通常应使用名词。如ClassLoader
、userId
对于方法名、函数名,应包含动词。如handleClick
、generateUniqueId
命名方法
常见的命名方法有驼峰命名法、匈牙利命名法、帕斯卡命名法、中/下划线命名法
驼峰命名法Camel-Case
驼峰命名法,又叫小驼峰命名法,如名称所表达的意思,指混合使用大小写字母老表示名字。
如userId
、getCompanyNameById
应用很广泛。
匈牙利命名法
基本原则是:变量名=属性+类型+对象描述。通过名称可以直观的了解他的所属、类型等信息。
是早期的命名方式,早期IDE没有很智能的时候,这种命名是很有必要的。
如iNum
,表示int类型的num
现在依旧很少有人用了。
帕斯卡命名法
又叫大驼峰命名法,就是把驼峰命名的首字母大写了。
如ClassLoader
中/下划线命名法
单词全部小写,单词和单词间用中划线或下划线分割。
如user_id
、python-flask-demo
下划线命名在数据库中较为常见。
常量命名法
这个不是官方的方法,但是常量一般是由固定规范的。
格式:所有单词的所有字母都是大写,单词之间用下户线连接。
如APOLLO_NAMESPAC
总结
好的命名习惯是每个程序员必备的基本素养。
写代码时,好的命名会让思路更加清洗,代码写的更加丝滑。
代码就是程序员的形象,从命名的细节开始,让自己更帅一些。
个人公众号:码农峰,定时推送行业资讯,持续发布原创技术文章,欢迎大家关注。
来源:oschina
链接:https://my.oschina.net/u/4390958/blog/4319046