如何使用godoc

时间:2018-03-18 19:55:57

标签: go godoc

godoc -html仅为一个包生成文档。但是,我想发送包含所有包的所有文档的项目,就像我运行godoc -http时一样。有了它,我可以找到所有包并从浏览器中浏览它们。

是否可以通过godoc -html为所有链接在一起的包生成HTML页面?

2 个答案:

答案 0 :(得分:1)

您在这里有两个问题:

  

是否可以为通过godoc -html链接在一起的所有软件包生成HTML页面?

不。因为它尚未在godoc(https://godoc.org/golang.org/x/tools/cmd/godoc)中实现。

另一个问题:

  

如何为文件夹中的所有软件包生成HTML文档   使用godoc

我认为最简单的方法是使用http标志godoc -http=:6060

启动godoc

然后,您导航到要获取文档的文件夹。对于该网址,您可以使用网络爬虫获取html文档。如果您不想自己编写搜寻器,则Go(https://godoc.org/?q=crawler)中已经有一些搜寻器。

答案 1 :(得分:0)

我开发了Golds,它是备用的Go docs生成工具(和本地docs服务器/代码读取器)。希望您能使用此工具满足您的需求。

在您的项目目录下,您可以运行以下任何命令来为Go项目生成HTML文档:

  • 金-gen -nouses -plainsrc -emphasize-wdpkgs ./...
  • 金-gen -nouses -emphasize-wdpkgs ./...
  • 金-gen -emphasize-wdpkgs ./...

第一个命令生成最紧凑的文档,最后一个命令生成完整的文档,其大小是紧凑文档的6倍。