使用godoc编写文档的方法是什么？

**使用 godoc 编写文档的指南** godoc 是一款工具，用于生成 Go 程序包的文档。本文档将指导您使用 godoc 创建清晰且全面的文档，涵盖函数、包和类型注释的编写方法。

我在应用程序中为函数和包创建了简单的注释 我尝试了 godoc -html 和我的应用程序以及结果

<!--
    copyright 2009 the go authors. all rights reserved.
    use of this source code is governed by a bsd-style
    license that can be found in the license file.
-->

<!--
        note: static (i.e., not template-generated) href and id
        attributes start with "pkg-" to make it impossible for
        them to conflict with generated attributes (some of which
        correspond to go identifiers).
-->

        <script type='text/javascript'>
        document.analysis_data = ;
        document.callgraph = ;
        </script>



                <p>
package main provides logic ...
</p>

为什么我没有看到我的其他文档？以及为什么包的

有空格

// Package main provides logic.
package main
import (

}

some types.....

func main() {
}

// doLogic .....
// .....
// ....
func (sm *myI) doLogic (s *myStruct) bool {

}

解决方案

默认情况下不记录未导出的标识符。至少设置 ?m=all 才能看到它们：

godoc所服务的网页的呈现方式可以通过“m”url参数来控制；它接受以逗号分隔的标志名称列表作为值：

all     show documentation for all declarations, not just the exported ones
methods show all embedded methods, not just those of unexported anonymous fields
src     show the original source code rather then the extracted documentation

例如，https://golang.org/pkg/math/big/?m=all 显示了包 big 的所有（不仅仅是导出的）声明的文档。 https://godoc.org/golang.org/x/tools/cmd/godoc

今天关于《使用godoc编写文档的方法是什么？》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！