注释、格式、对象与数据结构

  注释:注释的恰当用法是弥补我们在用代码表达意图时遭遇的失败;

     尽量减少注释量,用代码来阐述;

     好注释:法律信息、提供信息的注释、对意图的解释、阐述、警示;

     能用函数或变量时就别用注释;

     删除注释掉的代码;

     短函数不需要太多描述,为短函数选个好名字,通常要比写函数头注释要好;

  格式:垂直格式:每组代码行展示一条完整的思路,这些思路用空白行区隔开来;

          紧密相关的代码应该互相靠近;

          实体变量在类的顶部声明,局部变量声明尽可能靠近其使用位置;

          调用函数放在被调用函数上面;

          概念相关的代码应该放到一起;

     横向格式:尽力保持代码短小;

  对象与数据结构:数据抽象,隐藏实现关乎抽象;

          德墨忒耳定律:模块不应了解它所操作对象的内部情形;

          对象暴露行为,隐藏数据,便于添加新对象类型而无需修改既有行为;

          数据结构暴露数据,没有明显的行为,便于向既有数据结构添加新行为;

          避免出现混杂结构:一半是对象,一半是数据结构;

posted @ 2018-08-28 16:59  xiao_jian  阅读(305)  评论(0)    收藏  举报