取个好名子

1、名副其实

选个好名字要花费一定的时间,但省下来的时间比花掉的时间更多;

能做到见名知意,给后期维护减少成本,好的命名是不需要注释的。

2、避免误导

不要使用UNIX或类UNIX平台的专有名称;

也不要使用accountList来指一组账号,List对程序员有特殊意义;用accountGroup或bunchOfAccount,再或者用accounts也会好一些;

提防使用不同之处较小的名称;

如:0和o(英文字母o)

3、做有意义的区分

如有一个类User类。还有一个UserData或ProductInfo,虽然名字不同但是却无区别。

Variable一词永远不要出现在变量名中;

4、使用读得出来的名称


5、使用可搜索得名称

名称长短应与其作用域大小相对应;

若变量或常量可能在代码中多出使用,则应赋其以便于搜索得名称。

6、避免使用编码

对于接口和实现:

接口直接定义为ShapeFactory不需要IShapeFactory

7、避免思维映射

明确是王道

专业程序员善用其能,编写其他人能理解得代码。

8、类名

类名应该是名词或名词短语,如:Account、WikiPage和AddressParser避免使用Manager、Processor、Data或Info这样得类名。类名不应该是动词。

9、方法名

方法名应当是动词或动词短语,如:postPayment、deletePage或Save

10、别扮可爱

言道意到。意到言道。

11、每一个概念对应一个词


12、别用双关语

追加(往list添加数据)用insert或append,别使用add;不必为了风格统一而统一;

13、使用解决方案领域名称


14、使用源自所涉问题领域得名称


15、添加有意义得语境


16、不要添加没用的语境

只要短名称足够清楚,就要比长名字好。别给名称添加不必要的语境。











你可能感兴趣的:(取个好名子)