登录
首页 >  Golang >  Go问答

忽略“godoc”输出中的外部依赖项和标准库

来源:stackoverflow

时间:2024-04-07 18:18:30 200浏览 收藏

一分耕耘,一分收获!既然打开了这篇文章《忽略“godoc”输出中的外部依赖项和标准库》,就坚持看下去吧!文中内容包含等等知识点...希望你能在阅读本文后,能真真实实学到知识或者帮你解决心中的疑惑,也欢迎大佬或者新人朋友们多留言评论,多给建议!谢谢!

问题内容

我有一个使用 go 模块的 go 项目。我想使用 godoc 生成该项目包的文档。目前,我正在使用:

godoc -http=":6060"

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

有什么办法可以忽略这些吗?他们最多感觉是多余的。如果无法忽略它们,是否可以使用 godocgo doc 为项目包生成 html 格式的文档?


解决方案


以下是 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”输出中的外部依赖项和标准库》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多Golang知识!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>