1、命名要名副其实:
命名的时候一定要考虑他的显示意义和语境,不要认为把时间花费在变量的命名上很浪费。当然如果你程序很短的话,就不需要考虑那么多了,埋头就写代码。如果你的项目大,而且文件多的情况下,最好就是要花费时间在命名上,因为你的代码不仅仅只是你一个人看的。
2、避免误导:
也就是说不要把其他平台的关键字拿来命名,比如说我使用javascript语言,而我设计了一个变量为int,这让人会很头疼,为什么要一个int变量呢,难道这段代码是C++。这样就会让人产生误导。如果你想一个整型变量你可以这样,var intNumber;
3、做有意义的区分:
variable:永远不要拿来作为变量的名称、table永远不要拿来作为表的名称,等等。不要使用相似的命名,必须做有意义的区分,比如说:有一组变量,有些童鞋会这样命名,a1、a2、a3...,而如果我们根据他们的作用来命名效果会好很多。
4、使用容易读懂的名称:
最好就是使用一段英文,或者英文短语,切莫一些中文,一些英文混合,或者单纯的中文。比如:我们想写一个函数作用是,切换语言:qieHuanYuYan,这样的话大家读起来就会一个个的去拼写,而且最后还不一定能够拼写成功,如果改为:changeLanguage效果会好很多。
5、使用可搜索的名称:
我建议大家在使用阿拉伯数字的时候,最好能在代码的最开始,使用大写加下划线定义。比如说50度是一个人体能够承受的电力最大福特越界值,那么我们可以命名为:PEOPLE_MAX_VOLTA;当然我英语能力有点不好,但是基本是这个原理。如果单纯的使用50的话,会让人不知道这个是什么标准,如果变成变量就容易阅读。而且大家最好不要使用单个的英文字母,因为那样会造成相当大的麻烦,不仅仅是搜索,而且也难易理解。
6、避免使用编码:
不要使用一些前缀命名,比如说加一个m_之类的,这样虽然可以多次命名,但是会让人难以读懂。
7、避免思维映射:
避免单个名称,明确才是王道,不要以为你的单个名称别人看不懂,你就很牛逼。如果代码看起来像看小说一样,那才叫牛逼。
8、类名、方法名
类名应当是名词、或者名词短语。例如:Customer、WikiPage,避免使用Maneger、Perocessor这类带有动作的词语;方法名,尽量的能够体现出这个方法的动作,所以最好使用动词,或者动词短语,例如:postMail、deletePage,等等。
9、每个概念对应一个词:
给每个抽象概念选一个词并且一以惯之,例如使用get、方法,getMsg()、getUsername()、getUerId()等等。
10、不要使用双关语:
避免同一个单词用于不同的目的,比如说add这个就不是很好,可以使用append这类词语替换他。
11、添加语境:
就是给一些变量或者函数一些语境,比如说:这段变量,firstName、lastName、street、state,这些东西看起来我们都明白,但是我们都不知道他是描述什么的,如果加上address,改为;addressFirstName、addressLastName、addressStreet、addressState,这样的话就明朗很多了。
大家在对变量、函数、类命名的时候一定不要害怕他很长,只要能够读懂就好,当然如果短能够描述的清楚的话,还是必须得选择短的,我是想说如果想描述清楚,不要害怕变量、函数、类的命名太长。
变量、函数、类的命名规则
2020-07-20 16:22编程猫 编程技术
在阅读clean code书籍的时候,让我体会很多,因此我也用文字记录下这些有意义的知识。我认为这本书读十遍都不为过,下面我讲解一下自己的关于变量、函数、类的命名规则笔记。
延伸 · 阅读
- 2022-03-11Python变量的作用域详解
- 2022-03-11Python 函数装饰器应用教程
- 2022-03-11Python全栈之文件函数和函数参数
- 2022-03-10自定义Android注解系列教程之注解变量
- 2022-03-10C++ 函数的介绍
- 2022-03-10Python全栈之路正则函数
- 编程技术
Rust 能够取代 C 语言吗
Rust 是 Mozilla 基金会的一个雄心勃勃的项目,号称是 C 语言和 C++ 的继任者,这篇文章主要介绍了Rust 能够取代 C 语言吗的相关知识,需要的朋友可以参考下...
- 编程技术
一道算法小题的分析过程
最近在看算法的问题比较多,希望能以一道小题,来记录算法分析的过程。题目是: Pig Latin...
- 编程技术
火车头采集器采集多页内容的抓取教程
本文主要讲解使用火车头采集器采集多页内容的抓取教程,有需要的朋友可以参考下...
- 编程技术
前端:使用CSS3实现酷炫的3D旋转透视
3D动画效果现在越来越普及,已经被广泛的应用到了各个平台,比如阿里云,华为云,webpack官网等。它可以更接近于真实的展示我们的产品和介绍,带来极...
- 编程技术
git和SVN的区别小结
这篇主要是谈谈两者的区别,svn是集中式版本控制系统,git是分布式版本控制系统,至于谁优谁劣看官自己思考吧, ...
- 编程技术
网络编程之get与post的区别与联系
这里来说说get与post的区别与联系,对这方面不懂的同学可以参考下。...
- 编程技术
聊聊接口性能优化的11个小技巧
接口性能优化对于从事后端开发的同学来说,肯定再熟悉不过了,因为它是一个跟开发语言无关的公共问题。...
- 编程技术
分布式计算之数据质量漫谈
数据探查不止用在数据质量领域,数仓开发、数据迁移等都需要对源数据进行数据探查。数据仓库的所有数据基础都是源数据(ODS),在开发数仓之前,需...