知识卡片
源码注释也构成公开文档
包和函数声明前的说明可被文档工具提取,注释应解释职责、约束与可依赖行为。go doc可在编程前查已有包,降低重复实现成本。行注释和块注释是不同语法,块注释不能嵌套;原文把注释中的//和/*一概说成无意义过于笼统。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
在每一个函数之前写一个说明函数行为的注释也是一个好习惯。
参考来源
- 位置:《Go语言圣经》第01章《本章要点》(来源项目book-sources:extracted/Go语言圣经/_epub-src/ch1-08.html;spine 16,归一字符[2287,2315))
- 结论依据:原文连接声明前注释与godoc,正文补充注释边界并保留工具用途。
- 原始内容:在每一个函数之前写一个说明函数行为的注释也是一个好习惯。