从代码阅读看设计之简洁

来源:互联网 发布:手机养眼调控软件 编辑:程序博客网 时间:2024/04/28 16:25

     最近经常使用到一些类或控件,发现有些时候这些类并不是那么好用。有时候还开玩笑说,看来,我懂得的技术细节太少了。因为很多时候我需要了解很多东东才能明白如何使用他们。
     因此我想从代码阅读的角度去提出几点代码组织的要求:

  1. 如果有多个单元,主类实现的单元名称应该一样,方便定位
  2. 如果本单元中,实现了很多类,那么主类应该放在最上面。可以快速找到。
  3. public出来的方法是最先关注的,就连构造函数也可能是关注对象之一。因此这些方法的命名应该符合本语言的规范约束,叫法一致!比如Add、Delete、Remove、Insert等的意义
  4. 如果实现的功能过于专业,需要很多步骤才能完成,建议将这个流程的使用方法,放到单元注释或者类的注释中,方便查阅,易学!
  5. 如果用于派生覆盖的方法,建议统一放在一段上。如果附上派生说明,那就更好的。