知识卡片
文档注释关联对应声明
可提取说明应放在对应包或声明附近;段落之间用空白注释行表达结构,而不是期待任意源码换行都成为新段。遗留问题也可按工具支持的约定集中记录。
原书用go doc展示文本查询,并以godoc网页提供源码跳转,帮助读者从说明回到实现。旧godoc启动参数与BUG格式应按实际版本确认,不在本次启动服务或生成站点。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
若要将注释提取为文档,要遵守如下的基本规则。 注释需要紧贴在对应的包声明和函数之前,不能有空行。 9
参考来源
- 位置:《Go语言编程 完整版》第07章《工程管理》(来源项目book-sources:extracted/Go语言编程 完整版/_epub-src/text/part0000_split_003.html;spine 4,归一字符[8674,8726))
- 结论依据:原文给出注释贴近声明、段落与BUG记录规则以及doc查询/源码跳转用途。
- 原始内容:若要将注释提取为文档,要遵守如下的基本规则。 注释需要紧贴在对应的包声明和函数之前,不能有空行。 9