知识卡片
文档解释契约与选择理由
声明前注释可进入包文档,内容应解释用途、输入输出、边界和重要设计选择,而非逐字重复语法。可执行示例补充使用方式,但不能替代完整契约。原例F1实际上倍增却给出1、55的期望,说明文档和示例也会漂移,需要与实现一同维护。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 11.13 生成文档 · 查看原书依据
简而言之,不要写:这我创建了一个新的 int 变量。最好表明 int 变量的作用!然而,真正优秀的代码通常不需要文档!
参考来源
- 位置:《精通 Go(Mastering Go 中文版)》11.13 生成文档,spine227(book-sources;extracted/精通 Go(Mastering Go 中文版)/_epub-src/11.13.html)。
- 结论依据:本节注释建议与ExampleF1实际got20、4形成依据。
- 原始内容:简而言之,不要写:这我创建了一个新的 int 变量。最好表明 int 变量的作用!然而,真正优秀的代码通常不需要文档!