golang godoc

godoc是golang自动生成文档的工具，根据代码的注释和代码组织格式生成文档。

使用命令go get -v golang.org/x/tools/cmd/godoc即可安装godoc。

godoc xxxx,显示一个包的文档。

godoc -http=:80,80端口启动web文档服务，会显示goroot和gopath里面所有包的文档，相当一个本地的官网镜像服务。

可以在阅览器控制台输入下列js代码，可以统计这个包定义的函数和类型数量。

var func=0,type=0
for(var i of document.getElementById('manual-nav').getElementsByTagName("a")) {
    i = i.innerText
    if(i.indexOf("func ") == 0 ){
        func++
    }
    if(i.indexOf("type ") == 0 ){
        type++
    }
}
console.log("func num:", func)
console.log("type num:", type)

godoc.org是一个官方在线运行的godoc，可以用来查看一些公开的包的godoc文档。

例如: https://godoc.org/github.com/eudore/eudore

godoc.org就是一个公开的godoc server地址，github.com/eudore/eudore是包名称，也是uri路径。

使用web查看api

首先使用命令行godoc -http=:8020启动web服务，会使用GOROOT和GOPATH两个环境变量，GOROOT是godoc里面的标准库代码，GOPATH是godoc里面的第三方服务代码；或者使用https://godoc.org这个go官网的godoc服务。

登录地址http://192.168.75.4:8020/pkg/github.com/eudore/eudore，地址为为ip+/pkg/+包名称

例如最上边就是阅览器地址，下面就是这个包的godoc内容。

image

godoc目录结构为Overview、Index、Examples、Subdirectories。

• Overview为介绍是定义在package eudore前面的注释内容，通常在doc.go里面。

• Index是可导出的函数和对象的列表，按照字符顺序排序，可以点击跳转到对应的godoc。

• Examples定义在example_test.go文件，golang.org的example还可以在线运行。

• Subdirectories是当前包的子包。

例如eudore.App对象定义：

image

可以继续点击对象跳转到定义或者源码，godoc中链接都是蓝色文字可以跳转定义或源码。