在 go 中可以为包创建可见文档吗？

学习知识要善于思考，思考，再思考！今天golang学习网小编就给大家带来《在 go 中可以为包创建可见文档吗？》，以下内容主要包含等知识点，如果你正在学习或准备学习Golang，就都不要错过本文啦~让我们一起来看看吧，能帮助到你就更好了！

如何创建可见的 go 文档？

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

package main

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

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

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

正确答案

根据 official Go documentation 和 this link，应该可以像为函数创建文档一样为整个包创建文档：

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

例如：strings包：

// 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 关键字上方添加普通注释即可。

本篇关于《在 go 中可以为包创建可见文档吗？》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！