【问题标题】:Godoc: Limit Documentation to Project (Not Dependencies)Godoc:将文档限制为项目(不是依赖项)
【发布时间】:2019-12-25 23:31:15
【问题描述】:

我正在尝试使用 Godoc 为项目生成一些基本文档,但每次我这样做时,它都会为所有 Go 包添加文档。有没有办法控制它并让它只为我的项目代码生成文档?

我正在使用:

godoc -http=:6060

【问题讨论】:

  • 正如您从godoc --help 看到的,您不能将其限制为特定的包。不过,覆盖所有包并没有真正伤害任何东西 - 您是否有特定原因试图限制它?
  • 它包含了整个 Go 库的文档,这没有意义。没有理由将其包含在输出中。充其量只是分散注意力。
  • 如何分散注意力?只需转到您实际需要的文档即可。它并不是在一页上呈现所有包文档,您不必查看任何您不想看到的文档。生成“额外”文档似乎没有任何不利之处。
  • 我同意,文档很重,包括所有标准的 go 包和外部依赖文档,无论如何这些都可以在线获得。我认为不需要在每个项目级别的 godoc 实例上复制这些信息。

标签: go documentation documentation-generation godoc


【解决方案1】:

有没有办法控制它并让它只为我的项目代码生成文档?

没有。

【讨论】:

  • 您是否知道除了 Godoc 之外的任何文档生成工具都可以做到这一点?
  • @Brandon:“你知道除了 Godoc 之外的任何文档生成工具都可以做到这一点吗?”没有。
猜你喜欢
  • 2013-08-21
  • 2019-04-07
  • 1970-01-01
  • 2019-03-19
  • 1970-01-01
  • 2013-01-30
  • 2011-01-15
  • 2010-10-30
  • 1970-01-01
相关资源
最近更新 更多