使用godoc生成API文档。

huangapple go评论107阅读模式
英文:

Using godoc to make API

问题

我正在使用Go编写一个程序,并且已经格式化了我的注释以帮助生成文档。godoc是否具有使我的输出看起来专业的能力?类似于Go网站上看到的效果?我花了很长时间,成功在命令行上显示信息,但运行http命令总是只会打开Go主页。我真的不知道如何让它显示我的代码注释。

英文:

I am writing a program in Go and have formatted my comments to assist in making documents. Does godoc have the ability to make my output look professional? Similar to what is seen on the Go website? I spent a long time and was able to get the information to display on the command line but running the http command always just brought up the Go homepage. I'm really at a loss for how to get it to display my code's comments.

答案1

得分: 1

是的,如果你进入生成的 golang.org 网站的 /pkg 文件夹,你会看到你的包以及由 go-get 安装的所有内容,包括标准库模块。

但是你可以进入你的 GOPATH 的根源或者你想要文档化的项目的根源,然后尝试运行以下命令:godoc -http=":6060" -goroot=`pwd`

英文:

Yes, if you go to the /pkg folder of the generated golang.org site, you'll see your packages and everything installed by go-get among the standard library modules.

You can however go to the root source of either your GOPATH or the project you want to document, and try: godoc -http=":6060" -goroot=`pwd`

huangapple
  • 本文由 发表于 2014年2月6日 14:51:27
  • 转载请务必保留本文链接:https://go.coder-hub.com/21595993.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定