非零基础自学Golang 第15章 Go命令行工具 15.4 注释文档(doc)

非零基础自学Golang

第15章 Go命令行工具

15.4 注释文档(doc)

Go语言文档工具go doc和go fmt一样，也是对godoc的简单封装。

我们通常使用go doc查看指定包的文档。

例如我们查看函数fmt.Println的文档说明：

C:\Users\admin>go doc fmt.Println

Go语言文档是如何写的？我们可以查看fmt.Println的源码文件：

// Println formats using the default formats for its operands and writes to standard output.
// Spaces are always added between operands and a newline is appended.
// It returns the number of bytes written and any write error encountered.
func Println(a ...any) (n int, err error) {
   return Fprintln(os.Stdout, a...)
}

由此可以看出，Go语言的文档只需要在每个函数上方用注释的方式介绍该函数的作用及使用方法，go fmt命令就会自动将这些注释转化为文档展示出来。

gofmt命令有一个非常重要的参数-http，这个参数的作用是开启Web服务，提供交互式的文档查看页面。

godoc -http :8080

这里要用到 一个叫godoc 的工具，但是默认

是没有的

'godoc' 不是内部或外部命令，也不是可运行的程序或批处理文件。

这里笔者自己捣鼓了一种解决办法，

先下载 go 工具包的源码

https://github.com/golang/tools

如果是 那啥都不好使的，克都克隆 不下来的

直接进 GitHub 把源码下载下来

直接下载压缩包

直接解压

进到里面

在这儿，打开cmd

没毛病就OK 了

而且在我们 的GOPATH 下生成了一个 可执行文件

这下就可以 查看帮助了

再试一次

浏览器访问

牛逼，这样即可通过网页的方式查看Go语言文档了