知识卡片
自动文档仍需核对语义
文档工具可以把注释与声明提取成可查询页面,却不能检查承诺是否与实现相同。原书Foo注释说相等时返回0,代码却在相等时返回b,自动输出会原样保留这个矛盾。
因此文档与代码放近只是降低维护成本,不是正确性证明。输入边界、返回含义和失败行为需要作为同一契约核对,不能因为页面由工具生成就默认可信。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
Foo compares the two input values and returns the larger // value. If the two values are equal, returns 0. fun
参考来源
- 位置:《Go语言编程 完整版》第07章《工程管理》(来源项目book-sources:extracted/Go语言编程 完整版/_epub-src/text/part0000_split_003.html;spine 4,归一字符[7302,7412))
- 结论依据:原文同一例中实际注释与代码在相等输入矛盾,卡片据此限定自动提取的保证。
- 原始内容:Foo compares the two input values and returns the larger // value. If the two values are equal, returns 0. fun