知识卡片

普通读书笔记卡 · 2120.a.1

方法文档应显露行为契约

理解等级:中级

方法说明应让使用者知道为什么需要它、接受哪些输入或对象状态、成功后承诺什么,以及可能怎样失败。前置条件、后置条件和异常共同限定可用方式,不能只复述方法名。文档必须与真实实现保持一致;写出约束不代表代码已经验证,也不能从示例的法规编号推出现实规则。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    • · 查看原书依据

      需求(前置条件):方法需要什么样的输入,对象必须处于何种状态,才能让这个方法工作? 承诺(后置条件):方法成功执行后,对象现在处于什么状态,有哪些返回值? 异常:可能会发生什么样的问题?会抛出什么样的异常? 要感谢如RDoc 、javadoc 和ndoc 这样的工具,使

    参考来源

    - 位置:《高效程序员的45个习惯敏捷开发修炼之道 (图灵程序设计丛书 11)》26 用代码沟通(spine2;来源项目book-sources,`extracted/高效程序员的45个习惯敏捷开发修炼之道 (图灵程序设计丛书 11)/_epub-src/OEBPS/text00000.html`;来源键`u46-ch06-012`)。 - 结论依据:本单元完整正文、文本代码及相关图已实读;历史代码作为论证例,不冒称编译通过、性能测量或生产安全保证,源码排字错误按上下文明确处理。 - 原始内容:需求(前置条件):方法需要什么样的输入,对象必须处于何种状态,才能让这个方法工作? 承诺(后置条件):方法成功执行后,对象现在处于什么状态,有哪些返回值? 异常:可能会发生什么样的问题?会抛出什么样的异常? 要感谢如RDoc 、javadoc 和ndoc 这样的工具,使