我正在使用godocs来记录用go / golang编写的API,而我正在使用godocs对其进行记录,因为我会生成整个main.go文件的HTML页面,其中包含用于创建API的所有功能。但是,我不想显示有关我所有助手功能的信息,我只想显示有关文件中某些功能的标题信息。有没有办法只允许文件中的某些功能成为文档的一部分,还是必须为我的所有辅助功能创建另一个文件?现在,我正在本地端口8000上对其进行测试:godoc -http=:8000
命令godoc及其表亲go doc的默认行为是显示导出声明的软件包说明文件。奇怪的是,我没有找到一个简单的权威信息链接到该文档,从而明确地记录了这一事实,但是在更改默认行为的命令中引用了该事实,例如godoc软件包的文档:
godoc提供的网页的显示方式可以通过“ m” URL参数来控制;它接受以逗号分隔的标志名称列表作为值:
...
例如,http: //golang.org/pkg/math/big/?m=all,text以文本形式(如在使用godoc时所显示的)显示了big软件包的所有(不仅是导出的)声明的文档。从命令行:“ godoc -src math / big。*”)。
以及位于https://golang.org/src/go/doc/doc.go的源代码,其中包括:
81 const (
82 // extract documentation for all package-level declarations,
83 // not just exported ones
84 AllDecls Mode = 1 << iota
...
89 )
而https://golang.org/src/go/doc/exports.go文档与功能:
241 // fileExports removes unexported declarations from src in place.
最后go doc -h
在终端中运行会显示一个标志:
-u显示未导出的符号以及已导出的符号。
本文收集自互联网,转载请注明来源。
如有侵权,请联系 [email protected] 删除。
我来说两句