go doc 命令介绍

一：go doc 命令介绍

作用：打印出程序实体说明文档。后可不跟参数或一个参数或两个参数
格式：go doc 标记 参数
标记和参数可以不填，

• go doc
  在 main 包下，执行 go doc 默认是不打印的，除非加上 -cmd 标记，后面会讲
  在非 main 包下，执行 go doc 打印当前代码包文档及其程序实体列表（程序实体：变量、常量、函数、结构体以及接口）
• go doc 标记
  标记有如下：

标记	含义
-c	区分后跟参数的大小写，比如：go doc -c packageOne（默认不写是不区分大小写 ）
-cmd	加入此标记会使go doc命令同时打印出main包中的可导出的程序实体（其名称的首字母大写）的文档。默认下，这些文档是不会被打印的。
-u	加入此标记后会使go doc命令同时打印出不可导出的程序实体（其名称的首字母小写）的文档。默认下，这部分文档是不会被打印出来的。

• go doc 参数
  go doc 参数， 比如：go doc http.Request 会输出 http 包下 Request 文档说明，也可以跟两个参数，见下
  go doc 参数1 参数2，比如：go doc net/http Request ,需要说明的是第一个参数要写完整的导入路径，我个人理解就是在参数1 的范围下，打印出参数2的文档说明详情，其实此时 doc 和 参数之间还可以加入标记，相当于打印文档时又加入了条件判断。

二：godoc 工具介绍

作用：其实也是用于查看文档的，但与 go doc 还是有区别的。
godoc 模式一： 不添加 -http 标记

比如：godoc fmt 此时会纯文本打印出代码包fmt及其中所有可导出的包级程序实体的声明、文档和例子。

• 若仅想查看 fmt 包下的 Printf 函数，可以这样写： godoc fmt Printf 这是后接两个参数，个人理解还是在参数1 的范围内打印出参数2 的文档内容。

• 若要打印多个可以这么写：godoc fmt Printf Println

• 若想查看代码的同时看示例代码：godoc -ex net/http FileServer

• 若文档格式是 html 格式， 可以加上 -html 标记

godoc命令会去Go语言根目录和环境变量GOPATH包含的工作区目录中查找代码包。我们可以通过加入标记-goroot来制定一个Go语言根目录

godoc 模式二： 添加 -http 标记
可以理解为以 http 页面的形式查看 文档
比如：godoc -http=:6060 ，然后在网络浏览器的地址栏中输入 http://localhost:6060 来查看以网页方式展现的Go文档了。这与官网的文档说明是一样的。这样我们就可以再不方便访问Go语言官方站点的情况下也可以查看Go语言文档。

其实 godoc 还有好多可带的标记参数，这里只举其中的一个，要查看全部可以，在命令下敲击： godoc