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

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

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

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

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

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

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

  8. 方法名尽量使用动词。方法名尽量使用动词或动词短语。

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

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

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

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


20160807184518650.png


来源:【《代码整洁之道》精读与演绎】之二 高质量代码的命名法则


首页 我的博客
粤ICP备17103704号