你如何为使用 godoc 作为网页的 go 程序提供简单的文档？

对于一个Golang开发者来说，牢固扎实的基础是十分重要的，golang学习网就来带大家一点点的掌握基础知识点。今天本篇文章带大家了解《你如何为使用 godoc 作为网页的 go 程序提供简单的文档？》，主要介绍了golang，希望对大家的知识积累有所帮助，快点收藏起来吧，否则需要时就找不到了！

问题内容

我试图将特定的本地 go 文件作为文档网页提供，但无法做到。

官方 godoc 文档说：

使用 -http 标志（即 godoc 命令），它作为 Web 服务器运行并将文档显示为网页。

user_me$ godoc -http=:6060

这确实会创建类似于 go 页面的内容，但它不会呈现我想要呈现的特定文件。所以我试图提供我想要的文件的名称：

user_me$ godoc -http=:6000 hello.go

但是，它只是回复：

usage: godoc package [name ...]
    godoc -http=:6060
  -ex=false: show examples in command line mode
  -goroot="/usr/local/go": Go root directory
  -html=false: print HTML in command-line mode
  -http="": HTTP service address (e.g., ':6060')
  -httptest.serve="": if non-empty, httptest.NewServer serves on this address and blocks
  -index=false: enable search index
  -index_files="": glob pattern specifying index files;if not empty, the index is read from these files in sorted order
  -index_throttle=0.75: index throttle value; 0.0 = no time allocated, 1.0 = full throttle
  -links=true: link identifiers to their declarations
  -maxresults=10000: maximum number of full text search results shown
  -notes="BUG": regular expression matching note markers to show
  -play=false: enable playground in web interface
  -q=false: arguments are considered search queries
  -server="": webserver address for command line searches
  -src=false: print (exported) source in command-line mode
  -tabwidth=4: tab width
  -templates="": directory containing alternate template files
  -timestamps=false: show timestamps with directory listings
  -url="": print HTML for named URL
  -v=false: verbose mode
  -write_index=false: write index to a file; the file name must be specified with -index_files
  -zip="": zip file providing the file system to serve; disabled if empty

我也试过：

user_me$ godoc -url="localhost:8080" hello.go

但它没有用。

我也试过：

godoc -server=localhost:8080 hello.go

但它回答说：

2014/07/01 10:45:56 open /usr/local/go/src/pkg/hello.go: no such file or directory

我什至尝试只生成 html 本身：

godoc -html hello.go > hello.html

与上述相同的错误。

我也试过（因为它抱怨 pkg 目录中没有文件）：

godoc -html -goroo=$GOPATH hello.go > hello.html

最后，我放弃了。我不知道这个 godoc 是如何工作的。我安装了 hello.go 程序，以便工作区的 pkg 文件中有一些内容。您如何使用您的代码文档生成网页？

正确答案

godoc 对包和类型名称进行操作，而不是文件名。

例如，要了解io/ioutil包：

• 文本输出：godoc io/ioutil

• 只是ReadAll功能：godoc io/ioutil ReadAll

• 在 HTML 中：godoc -html io/ioutil ReadAll

• 在浏览器中：

  • godoc -http=:6060
  • 单击包并从那里导航
  • 或直接前往http://localhost:6060/pkg/io/ioutil#ReadAll

要查看您自己的代码的文档，它必须包含在您的GOPATH.

假设您的GOPATHincludes$HOME/go/src和您感兴趣的文件是$HOME/go/src/hey/world/doc.go，您将运行：

godoc hey/world

...或以 HTTP 模式启动 godoc 并浏览到http://localhost:6060/pkg/hey/world

理论要掌握，实操不能落！以上关于《你如何为使用 godoc 作为网页的 go 程序提供简单的文档？》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！