程序员的命名素养

引言

今天来聊聊命名相关内容。php

在平常工做中,项目、类、方法、表等等等等,都须要咱们起名来标识区分。好的名字让人赏心悦目,很差的名字让人看的想吐。前端

最近工做有幸写了node、前端、php、sql、scala,也见识了公司各位前辈们的命名功底。其中不乏abc命名、拼音命名、蹩脚英文命名,更有很多从别的地方粘过来连名都不改的操做。node

命名没有对错,只是规范一点,能够提升可读性、可维护性。python

命名原则

拼写正确

拼写正确是可读的基础。mysql

play shiftplay shit本身体会一下程序员

清新明了,见名知意

根据要表达的内容命名,一针见血。sql

getNameById 根据id获取名称
ClassLoader 类加载器
MYSQL_USERNAME mysql用户名

如上几个例子,咱们一眼就知道要表达什么,可读性高。数据库

使用英文字母命名

在编程中,英文仍是较为主流的,最好使用单词来命名,再不济也是用拼音来命名。编程

不管是拼音或单词,清晰表意是首要。flask

保持一致

在一个项目中,应该使用统一的规范来命名。

无规矩不成方圆。

合理使用动词名词

类名、变量名一般应使用名词。如ClassLoaderuserId

对于方法名、函数名,应包含动词。如handleClickgenerateUniqueId

命名方法

常见的命名方法有驼峰命名法、匈牙利命名法、帕斯卡命名法、中/下划线命名法

驼峰命名法Camel-Case

驼峰命名法,又叫小驼峰命名法,如名称所表达的意思,指混合使用大小写字母老表示名字。

userIdgetCompanyNameById

应用很普遍。

匈牙利命名法

基本原则是:变量名=属性+类型+对象描述。经过名称能够直观的了解他的所属、类型等信息。

是早期的命名方式,早期IDE没有很智能的时候,这种命名是颇有必要的。

iNum,表示int类型的num

如今依旧不多有人用了。

帕斯卡命名法

又叫大驼峰命名法,就是把驼峰命名的首字母大写了。

ClassLoader

中/下划线命名法

单词所有小写,单词和单词间用中划线或下划线分割。

user_idpython-flask-demo

下划线命名在数据库中较为常见。

常量命名法

这个不是官方的方法,可是常量通常是由固定规范的。

格式:全部单词的全部字母都是大写,单词之间用下户线链接。

APOLLO_NAMESPAC

总结

好的命名习惯是每一个程序员必备的基本素养。

写代码时,好的命名会让思路更加清洗,代码写的更加丝滑。

代码就是程序员的形象,从命名的细节开始,让本身更帅一些。


我的公众号:码农峰,定时推送行业资讯,持续发布原创技术文章,欢迎你们关注。

相关文章
相关标签/搜索