从代码阅读看设计之简洁
2007-10-27 18:48
274 查看
2006年10月19日 13:18:00
最近经常使用到一些类或控件,发现有些时候这些类并不是那么好用。有时候还开玩笑说,看来,我懂得的技术细节太少了。因为很多时候我需要了解很多东东才能明白如何使用他们。
因此我想从代码阅读的角度去提出几点代码组织的要求:
如果有多个单元,主类实现的单元名称应该一样,方便定位
如果本单元中,实现了很多类,那么主类应该放在最上面。可以快速找到。
public出来的方法是最先关注的,就连构造函数也可能是关注对象之一。因此这些方法的命名应该符合本语言的规范约束,叫法一致!比如Add、Delete、Remove、Insert等的意义
如果实现的功能过于专业,需要很多步骤才能完成,建议将这个流程的使用方法,放到单元注释或者类的注释中,方便查阅,易学!
如果用于派生覆盖的方法,建议统一放在一段上。如果附上派生说明,那就更好的。
Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=1340878
最近经常使用到一些类或控件,发现有些时候这些类并不是那么好用。有时候还开玩笑说,看来,我懂得的技术细节太少了。因为很多时候我需要了解很多东东才能明白如何使用他们。
因此我想从代码阅读的角度去提出几点代码组织的要求:
如果有多个单元,主类实现的单元名称应该一样,方便定位
如果本单元中,实现了很多类,那么主类应该放在最上面。可以快速找到。
public出来的方法是最先关注的,就连构造函数也可能是关注对象之一。因此这些方法的命名应该符合本语言的规范约束,叫法一致!比如Add、Delete、Remove、Insert等的意义
如果实现的功能过于专业,需要很多步骤才能完成,建议将这个流程的使用方法,放到单元注释或者类的注释中,方便查阅,易学!
如果用于派生覆盖的方法,建议统一放在一段上。如果附上派生说明,那就更好的。
Trackback: http://tb.blog.csdn.net/TrackBack.aspx?PostId=1340878
相关文章推荐
- 从代码阅读看设计之简洁
- 从代码阅读看设计之简洁
- 从代码阅读看设计之简洁
- 从代码阅读看设计之简洁
- 从源代码剖析modelDriven拦截器和params拦截器和拦截器prepare 和paramsPrepareParamsStack拦截器栈(使您的Struts2代码更加简洁——怎样培养框架设计能力
- 《重构--改善代码的既有设计》阅读笔记之代码的坏味道
- 开始阅读《重构--改善既有代码的设计》
- 阅读高手编写的类似QQ聊天的服务端代码DAO设计总结
- 知晓设计模式,框架,去提高开发效率,使代码简洁
- 02重构_改善既有代码的设计阅读笔记之二
- 理想的设计特征(代码大全阅读)
- 代码坏味道 重构: 改善有效代码的设计--阅读笔记
- 对于一个糟糕的设计来说,通过阅读C++代码你可以很容易地识别出它。
- 03重构_改善既有代码的设计阅读笔记之三
- 阅读《重构 改善既有代码的设计》学习笔记
- 关于阅读《重构,改善既有代码的设计》的一些思考
- 应用反射技术为Infragistics Solution设计例子程序 代码简洁而且学习的效率高
- 阅读:重构——改善既有代码的设计
- 应用反射技术为Infragistics Solution设计例子程序 代码简洁而且学习的效率高
- 应用反射技术为Infragistics Solution设计例子程序 代码简洁而且学习的效率高