知识卡片
文档排版先保证普通文本可读
行注释到行末,块注释可跨行且不支持块注释嵌套;行注释也可跟在代码后,原书称只能独占一行不准确。文档以自然段、缩进代码和必要列表组织,不用随意HTML装饰。当前Go文档有专门格式规则,旧godoc用法及纯文本限制不能当永久规范;常量组也允许逐项添加说明。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 程序测试和文档 · 查看原书依据
行注释能且只能占用单独一行来存放注释的内容。它是最基本的注释方式,并可以出现在源码文件中的任何地方。 块注释是更加灵活的一种注释方式。
参考来源
- 位置:《Go并发编程实战》第05章《程序测试和文档》之《5.2 程序文档》(来源项目book-sources;源文件:extracted/Go并发编程实战/_epub-src/text/part0000_split_036.html)
- 结论依据:原文围绕文档排版先保证普通文本可读给出定义、实例或限制;卡片结合这些上下文解释条件,已知错误在正文就近校正。
- 原始内容:行注释能且只能占用单独一行来存放注释的内容。它是最基本的注释方式,并可以出现在源码文件中的任何地方。 块注释是更加灵活的一种注释方式。
外部补充核验:2026-10-26核验Go文档注释指南 https://go.dev/doc/comment ,区分原书godoc示例与当前文档格式。