【问题标题】:Ignore external dependencies and standard library in `godoc` output忽略“godoc”输出中的外部依赖项和标准库
【发布时间】:2020-06-15 04:44:42
【问题描述】:

我有一个使用 Go Modules 的 Go 项目。我想使用godoc 为这个项目的包生成文档。目前,我正在使用:

godoc -http=":6060"

当然,这会生成项目的文档,但它也会生成标准库和导入的依赖项的文档。

有什么办法可以忽略这些吗?他们充其量只是觉得多余。如果无法忽略它们,有没有办法使用godocgo doc 为项目的包生成HTML 格式的文档?

【问题讨论】:

  • 不,该命令不会生成文档。它只是启动一个服务于已经生成的文档的服务器。 Godoc 只是 cmets(和导出的符号)。您在编写代码时生成它。请参阅 Go 官方博客中的 Godoc: documenting Go code
  • 明白了,感谢@Flimzy 的解释/链接

标签: go godoc


【解决方案1】:

这些是godoc 可用的选项:

$ godoc --help
usage: godoc package [name ...]
    godoc -http=:6060
  -all
        include unexported identifiers in command-line mode
  -analysis string
        comma-separated list of analyses to perform (supported: type, pointer). See http://golang.org/lib/godoc/analysis/help.html
  -ex
        show examples in command line mode
  -goroot string
        Go root directory (default "/usr/local/go")
  -html
        print HTML in command-line mode
  -http string
        HTTP service address (e.g., ':6060')
  -httptest.serve string
        if non-empty, httptest.NewServer serves on this address and blocks
  -index
        enable search index
  -index_files string
        glob pattern specifying index files; if not empty, the index is read from these files in sorted order
  -index_interval duration
        interval of indexing; 0 for default (5m), negative to only index once at startup
  -index_throttle float
        index throttle value; 0.0 = no time allocated, 1.0 = full throttle (default 0.75)
  -links
        link identifiers to their declarations (default true)
  -maxresults int
        maximum number of full text search results shown (default 10000)
  -notes string
        regular expression matching note markers to show (default "BUG")
  -play
        enable playground in web interface
  -q    arguments are considered search queries
  -server string
        webserver address for command line searches
  -src
        print (exported) source in command-line mode
  -tabwidth int
        tab width (default 4)
  -templates string
        load templates/JS/CSS from disk in this directory
  -timestamps
        show timestamps with directory listings
  -url string
        print HTML for named URL
  -v    verbose mode
  -write_index
        write index to a file; the file name must be specified with -index_files
  -zip string
        zip file providing the file system to serve; disabled if empty

【讨论】:

  • 我知道并已通读(以及godoc.org/golang.org/x/tools/cmd/godoc),但除非我遗漏了什么,否则这些似乎都没有按照我的要求进行
  • 如果我没有遗漏任何东西,我想现阶段是不可能的¯\_(ツ)_/¯
  • 所以我错过了一些东西:P 很公平,感谢您的解释!
  • @wbr:所以你的意思是,如果你正在浏览你本地项目的 godoc,并且你看到一个接受http.Transport 类型参数的函数,你想要 那个链接要断开了?
  • 除了明显损坏的用例之外,如果您像许多通勤者一样在没有可靠互联网连接的情况下工作,则提供 stdlib 文档很有用。
猜你喜欢
  • 1970-01-01
  • 2014-11-27
  • 2013-07-06
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多