知识卡片
公开注释解释职责与使用条件
靠近包、类型或函数的文档注释,让使用者在接口处理解对象的职责和调用条件。除重复名称外,更有价值的是结果含义、错误、并发访问与生命周期限制。原书Documentation示例展示注释附着位置,但空Display实现不等于行为已完成;文档应描述真实契约,不因工具能显示就写成已实现功能。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 十、高级并发和最佳实践 · 查看原书依据
Go让编写代码变得超级容易,你绝对应该这样做。只需在每个标识符(包、类型或函数)上方添加单行注释,即可将其附加到上下文文档中,如下代码所示:
参考来源
- 位置:《精通 Go 并发(机翻)》spine13《十、高级并发和最佳实践》(book-sources;extracted/精通 Go 并发(机翻)/_epub-src/OEBPS/Text/12.html)。
- 结论依据:原文展示注释附在包/类型/方法之上,Display实际空实现;卡片要求文档与真实职责和限制一致。
- 原始内容:Go让编写代码变得超级容易,你绝对应该这样做。只需在每个标识符(包、类型或函数)上方添加单行注释,即可将其附加到上下文文档中,如下代码所示: