在写boxgo的过程中,想要生成漂亮的godoc,发现不太熟悉godoc的用法,所以就有了本篇文章,记录一下。 Go团队非常重视文档,文档对项目的可阅读性、可维护性起到重要作用,所以写好文档变得非常重要。Go团队提供了godoc工具以帮助开发者方便、准确,容易的生成项目文档。godoc解析Go源代码(包括注释),并以HTML或纯文本格式生成文档。 生成文档 提取规则: 类型、变量、常量、函数,包都可以通过在声明的前面写注释的方法生成文档(中间不要有空行)。 1// Package doc 包注释 --- good 2package doc 3 4type ( 5 // UserType 类型注释 --- good 6 …
阅读更多