go - 是否可以为 go 中的包创建可见文档？

Question

如何创建可见的 Go 文档？

这很容易为 go 中的任何函数创建文档，如下所示：

package main

// documentation example
func DocumentedFunction() bool {
    return true
}

当我调用该函数时，我可以看到该文档：

我可以编写可以从编辑器/IDE 中看到的包文档吗？我是否必须安装其他工具才能实现包文档的类似行为？

Answer 1

根据官方 Go 文档和此链接，应该可以为整个包创建文档，就像为函数创建文档一样：

要记录一个函数、类型、常量、变量，甚至是一个完整的包，请在其声明之前直接写一个常规注释，中间不要有空行。

例如：字符串包：

// Package strings implements simple functions to manipulate UTF-8 encoded strings.
//
// For information about UTF-8 strings in Go, see  https://blog.golang.org/strings.
package strings
..
..
rest of the file

package因此，您基本上只需在关键字上方添加普通注释即可。