知识卡片

普通读书笔记卡 · 5624.c.1

文档说明调用契约与用途

理解等级:中级

声明旁注释会成为包和成员文档,首句应简述职责,再说明参数、返回、错误或重要限制。长包说明可放doc.go,文档需要随代码维护;简洁不等于遗漏会改变调用判断的约束。go doc可查询包、函数和方法,图10.1展示的godoc页面是历史工具界面,不代表所有服务入口仍相同。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《Go语言圣经》第10章《工具》(来源项目book-sources:extracted/Go语言圣经/_epub-src/ch10-07.html;spine 100,归一字符[6823,6837)) - 结论依据:原文文档注释和Fprintf返回计数/错误说明支持契约用途。 - 原始内容:文档也是需要像代码一样维护的