我有一个使用 Go Modules 的 Go 项目。我想用来godoc
为这个项目的包生成文档。目前,我正在使用:
godoc -http=":6060"
当然,这会生成项目的文档,但它也会生成标准库和导入的依赖项的文档。
有什么办法可以忽略这些吗?他们充其量只是觉得多余。如果无法忽略它们,是否有任何方法可以为项目的包使用godoc
或go 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