2021-10-26
注释用于对一些代码的解释，对初学Go代码或者其他语言很友好，对代码后期的维护更新也很方便。
跟大部分语言一样，Go语言也有两种注释
- 单行注释，行注释。最常见的注释形式，不超过三行
//单行注释</pre>
- 多行注释，块注释。多用于需要大量注释的代码块
/*
第一行注释
第二行注释
。。。
*/
godoc 工具
下载地址：https://github.com/golang/tools.git
解压之后，进入cmd/godoc目录下
终端执行
go build，会生成一个godoc.exe文件将生成的godoc.exe文件放到安装go目录下的bin
通过执行godoc会出现以下效果
godoc
例子：
go doc fmt，输出fmt包的文档注释
image.png
godoc 工具一般有以下几种用法：
- go doc package：获取包的文档注释，例如
go doc fmt会显示使用 godoc 生成的 fmt 包的文档注释； - go doc package/subpackage：获取子包的文档注释，例如
go doc container/list； - go doc package function：获取某个函数在某个包中的文档注释，例如
go doc fmt Printf会显示有关 fmt.Printf() 的使用说明。
同时也可以作为Web服务器运行，并将文档显示为网页
godoc -http=:8989
image.png
用法
godoc [选项]
-v
详细模式
-timestamps=true
显示带有目录列表的时间戳
-index
启用标识符和全文搜索索引
（如果 -index 未设置，
则不显示搜索框）-index_files=""
指定索引文件的 glob 模式；如果不为空，
则按
排序顺序从这些文件中读取索引-index_throttle=0.75
索引节流值；值 0 表示没有时间分配
给索引器（索引器永远不会完成），值 1.0
表示索引创建正在全速运行（其他
goroutine 在构建索引时可能没有时间）
-templates=""
包含备用模板文件的目录；如果设置，
该目录可以为
$GOROOT/lib/godoc 中的文件提供替代模板文件
-url=path
打印到标准输出将由
HTTP 请求提供的数据
-zip=""
提供文件的 zip 文件服务系统；
更加详细的解释在官方文档也可以看到
