一、为什么需要规约
很多bug来自于双方之间的误解,若不写规约,那么不同开发者的理解可能不同,没有规约,难以定位错误。开发者代码中的数据类型和一些关键字本身蕴含了设计决策,给编译器读。采取规约,以注释形式写出设计决策,给自己和别人读,防止自己记不住或别人看不懂。规约还可以扮演防火墙角色,将用户和开发者隔离开,只讲能做什么,不讲怎么实现。
二、行为等价性
行为等价形是站在客户角度看行为等价性,不看内部具体实现。根据规约判断是否行为等价。若两个方法满足同一个规约,则可以说这两个方法行为等价。
三、设计规约
前置条件:对客户端的约束,在使用方法是必须满足的条件@para
后置条件:对开发者的约束,方法结束时必须满足的条件。@return和@throws
契约:如果前置条件满足了,后置条件必须满足。
tip:前置条件不满足,则方法可以做任何事情
规约需要展示给用户,javadoc可以将规约自动提取到文档中。