编写高质量代码二—命名规则

作者: 归零者 分类: 编程规范 发布时间: 2018-09-01 10:03

导言: 编写代码时候的命名非常重要,这不仅仅关系到你个人职业成长,还关系项目的后期维护和长远发展. 这一节来分享下自己学习,整理和抄袭的一些命名规则,直接看思维导图吧,记住并遵守,经常性的对照检测自己的代码会有事半功倍的效果。 思维导图: 代码整洁之道二.png

总结:

1.要名副其实。一个好的变量、函数或类的名称应该已经答复了所有的大问题。一个好名称可以大概告诉你这个名称所代表的内容,为什么会存在,做了什么事情,应该如何用等。

2.要避免误导。我们应该避免留下隐藏代码本意的错误线索,也应该避免使用与本意相悖的词。

3.尽量做有意义的区分。尽量避免使用数字系列命名(a1、a2…….aN)和没有意义的区分。

4.尽量使用读得出来的名称。如名称读不出来,讨论的时候会不方便且很尴尬。

5.尽量使用可搜索的名称。名称长短应与其作用域大小相对应,若变量或常量可能在代码中多处使用,应赋予其以便于搜索的名称。

6.取名不要绕弯子。取名要直白,要直截了当,明确就是王道。

7.类名尽量用名词。类名尽量用名词或名词短语,最好不要是动词。

8.:方法名尽量用动词。方法名尽量用动词或动词短语。 9.每个概念对应一词,并一以贯之。对于那些会用到你代码的程序员,一以贯之的命名法简直就是天降福音。

10.通俗易懂。应尽力写出易于理解的变量名,要把代码写得让别人能一目了然,而不必让人去非常费力地去揣摩其含义。

11.尽情使用解决方案领域专业术语。尽管去用那些计算机科学领域的专业术语、算法名、模式名、数学术语。

12.要添加有意义的语境。需要用有良好命名的类,函数或名称空间来放置名称,给读者提供语境。若没能提供放置的地方,还可以给名称添加前缀。

本文非原创,看原文请关注此大神:https://my.csdn.net/zhmxy555

如果觉得我的文章对您有用,请随意赞赏。您的支持将鼓励我继续创作!

说点什么

avatar
  Subscribe  
提醒
跳至工具栏