- 命名:
- 使用的名字要见名知意: 由于代码所处的上下文并不会或不会清晰地在这个代码中体现出来, 所以命名需要十分准确, 多考虑.
- 避免命名歧义: 避免有特殊含义的词出现在名称中.
- 有时在同一个上下文中为了避免名字冲突需要对具有类似含义的名字进行处理, 一般都是改变�或增加后缀等, 但改变后的名字必须要一看就懂.
- 不要使用数字去增加后缀.
- 有些时候两个实体的意义相近, 但功能不同的时候, 不要使用近义词来表示, 因为两个近义词表示的意思在人理解上是一样的, 这样的代码并不可读.
- 慎用缩写, 因为不能保证一看就完全清楚是它是什么意思.
- 接口不要加前缀了, 因为用法都是一样的.
- 类名要使用名词或名词性的短语. 并且避免 Manager, Processor, Data或是Info这样的词出现在里面, 同时不能包含动词.
- 方法名应该包含动词或动词短语, 因为这样能够描述该方法的实际作用.
- 不要使用太 cute 的名字.
- 对于每一个概念, 在应用中应该都使用统一的命名.
- 不要用一个名字表达多个意思.
- 使用和问题相关领域的名字.
- 为名字添加有意义的上下文.
- 不要在名字中添加没有理由的词汇.
网友评论