代码中使用了超长的命名会影响代码的清晰性。同时,超长的变量命名会造成换行,这会影响代码的结构,不易于阅读。
长的类名会使开发者不易声明该类型的变量
长的方法命名会使它变得晦涩难懂
长的变量命名不利于代码重用,导致过长的方法链
别慌,下面我们来看看如何解决这一问题。
选择一个好的命名
命名有两个目标:
清晰:你要知道该命名与什么有关
精确:你要知道该命名与什么无关
当一个命名完成上面两个目标之后,其余的字符就是多余的了。
命名中无需含有表示变量或参数类型的单词
如果使用如Java之类的静态类型语言,开发者通常知道变量的类型。由于方法的实现一般都比较简短,所以即便是在查看一个需要推断才知道类型的本地变量,或者在code review等静态分析器不可用的情况下,我们也可以通过多看很少的几行代码就能知道变量的类型。
所以将类型说明加入到变量名中是多余的。我们应该舍弃匈牙利命名法,如下:
// 不好的:
String nameString;
DockableModelessWindow dockableModelessWindow;
// 改进:
String name;
DockableModelessWindow window;
特别是对于集合来说,最好使用名词的复数形式来描述其内容,而不是使用名词的单数形式来描述。如果开发者更在乎集合中存储的内容,那么变量命名应当反映这一点。
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
全部0条评论
快来发表一下你的评论吧 !