最新消息:热烈庆祝IT小记上线!

代码整洁之道___更好的命名规范

软件中随处可见命名,我们给变量、函数、参数、类和封包命名。我们给源代码所在目录命名。我们命名不断。既然有这么多命名要做,不妨做好它,下面是取个好名字的几条简单规则。

  1. 名副其实:取名字要根据语意来,体现本意的名称能让人更容易理解和修改代码;
  2. 避免误导:避免留下掩盖本意的错误线索,应当避免使用与本意相近的词;
  3. 做有意义区分:要区别名称,就要以读者能鉴别的不同之处的方式来区分;
  4. 使用读者读的出来的名称:不要用一些没有规则的字母;
  5. 使用可搜索的名称:但字母名称和数字常量有个问题,很难从一大堆文字中找出来。找MAX_CLASSES_PER很容易,但找7很难。名称长短应与其作用域大小相对应。若常量或变量可能在代码中多处使用,则应赋值其以便于搜索的名称。
  6. 避免使用编码: 6.1匈牙利语标记法 6.2成员前缀 6.3接口和实现;
  7. 避免思维映射:不应到让读者在脑中把你的名称翻译为他们熟知的名称。这种问题经常出现在选择是使用问题领域术语还是解决方案领域术语时;
  8. 类名:类名和对象名应该是名词和名词短语,避免使用Manager、Processor、Data、Info这样的类名。类名不应到是动词;
  9. 方法名:方法名应当是动词和动词短语,如postPayment、deletePage或save。属性访问器、修改器和断言应该根据其值命名并依Javabean标准加上get、set和is前缀;
    1. 别扮可爱:不用哩语;
    2. 每个概念对应一个词:给每个抽象概念选一个词,并且一以贯之。在同一堆代码中,有controller又有manager还有driver就会令人困惑;
    3. 使用解决方案领域名称:;
    4. 使用源自所涉问题领域的名称;
    5. 添加有意义的语境;
    6. 不要添加没用的语境;
上一篇 HDU 1754 I Hate It

猜您喜欢

备案号:苏ICP备12016861号-4