代码简洁之道:命名规范

2023-01-18  本文已影响0人  飞猪的浪漫

1. clean code:

避免与本意相悖的词:hp,aix,sco不该做变量名(都是UNIX平台专有名词)

不用list;毕竟不是list类型。

避免不同之处较小的名称:前后不可以拼写不一样。

1,o作为变量;引发误解。

不要a1.a2.a3等命令。

info和data的后缀也会多余,废话也无法做有效的区分。

a和the这样的前缀有意义。区别函数内和全体的函数。

variable不该做变量,table不该做表名;object不该做类。

需要设定规矩,来做合理的区分。

名称需要读的出来:可以说出来和记得;单字母应用与单方法中的本地变量;名称长短与作用域相对应。

变量常量经常使用,给他便于搜索的名称。

不需要m_作为前缀,名称需要有意义的部分。

1. 不需要I开头作为修饰;不需要编码的方式作为接口名称。

不要把你的名称翻译成他们熟知的名称;

单字母可以做循坏,但是其他情况不合适。没有名称冲突,作用域较小。

类名对象应该是名词或者名词短语;方法名:动词或者动词短语。

可以加上get,set和is前缀。

1,给每个抽象概念,选一个词。函数名词应该独一无二,还要保持一致,

不要controller,manager,driver。选用一个标准。

一词一意,语义上等价,add要保持一致的用法。参数列表和返回值在语义上等价的。

1. 使用解决方案领域的名词:计算机术语,算法名,模式名,数学术语。

如果不可以的话,就要源自所涉问题领域的名称;至少可以请教专家。

有良好命名的类,函数,名称空间来放置名称,给读者提供语境。

和算法一起,给reviewer提供有意义的语境。

如果短名称足够清晰,就比长名称好。别给名称添加不必要的语境。

精确是命令的主要核心。另外,搜一个G,自动生成的结果不需要太多。(结果也不需要太长)

函数:

1. 要短小;if ,else,while语句要一行。

2. 只做一件事,均在函数名下的同一抽象层次。函数:把大的概念,拆分成多个不同抽象层次的步骤。

函数是否做一件事情:是否拆出一个函数,单纯地诠释实现。

程序:自顶而下的阅读顺序;每一个函数后面都跟着位于下一抽象层次的函数;查看列表时,可以顺着抽象层次向下阅读。

程序就像是一系列TO起头的段落,每一段都是描述当前抽象层次,并应用下一个抽象层次的TO起头段落。

上一篇 下一篇

猜你喜欢

热点阅读