Go语言注释的定义及使用（godoc工具提取注释内容）

在讲解Go语言注释之前，大家可以先来看一下下面这段代码。

//test.go
package main

import "fmt" // 引入 fmt 包

func main() {
   fmt.Printf("Καλημέρα κόσμε; or こんにちは 世界\n")
}

上面这个例子通过打印“Καλημέρα κόσμε; or こんにちは 世界”展示了如何在Go语言中使用国际化字符，以及如何使用注释。

注释不会被编译，但可以通过 godoc 来获取。

Go语言中注释一般分为两种，分别是单行注释和多行注释：

• 单行注释是最常见的注释形式，可以在任何地方使用以 // 开头的单行注释；
• 多行注释也叫块注释，均已以 /* 开头，并以*/结尾，且不可以嵌套使用，多行注释一般用于包的文档描述或注释成块的代码片段。

每一个包都应该有相关注释，上述代码中在 package 语句之前的注释内容将被默认认为是这个包的文档说明，其中应该提供一些相关信息并对整体功能做简要的介绍，一个包可以分散在多个文件中，但是只需要对其中一个进行注释说明即可。

当开发人员需要了解包的一些情况时，自然会用 godoc 来显示包的文档说明。在首行的简要注释之后可以用成段的注释来进行更详细的说明，而不必拥挤在一起。另外，在多段注释之间应以空行分隔加以区分，如下所示：

// Package superman implements methods for saving the world.
//
// Experience has shown that a small number of procedures can prove
// helpful when attempting to save the world.
package superman

几乎所有全局作用域的类型、常量、变量、函数和被导出的对象都应该有一个合理的注释，如果这种注释（称为文档注释）出现在函数前面，例如函数 Abcd，则要以 "Abcd..." 作为开头，如下所示：

// enterOrbit causes Superman to fly into low Earth orbit, a position
// that presents several possibilities for planet salvation.
func enterOrbit() error {
   ...
}

godoc 工具

godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档，也可以作为一个提供在线文档浏览的 web 服务器，Go语言官网（https://golang.google.cn/）就是通过这种形式实现的。

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() 的使用说明。

godoc 工具只能获取在 Go 安装目录下 ../go/src 中的注释内容，此外，它还可以作为一个本地文档浏览 web 服务器，在命令行输入 godoc -http=:6060，然后使用浏览器打开 http://localhost:6060 后，就可以看到本地文档浏览服务器提供的页面。


此外 godoc 也可以用于生成非标准库的 Go 源码文件的文档注释。