知识卡片
包注释界定整体职责
包注释放在 package 子句之前,说明整个包解决什么问题及适用范围,而非重复某个函数的行为。多文件包只需在一个文件写一次;它会先于各项细节展示,帮助读者判断是否应继续阅读包内 API。包越简单,说明也可以越短。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
- · 第03章 注释
原书出处 · 1 处
- 注释 · 查看原书依据
每个程序包都应该有一个包注释,一个位于package子句之前的块注释。对于有多个文件的程序包,包注释只需要出现在一个文件中,任何一个文件都可以。包注释应该用来介绍该程序包,并且提供与整个程序包相关的信息。
参考来源
- 位置:《Effective Go中文版》第03章《注释》(源文件:`_epub-src/OEBPS/注释.md.html`)
- 结论依据:原文规定包注释的位置与多文件包的数量,并说明其用途是介绍整个包、出现在文档页最前面。
- 原始内容:每个程序包都应该有一个 包注释 ,一个位于package子句之前的块注释。对于有多个文件的程序包,包注释只需要出现在一个文件中,任何一个文件都可以。包注释应该用来介绍该程序包,并且提供与整个程序包相关的信息。