如何使用`godoc`生成HTML文件?
我写了一个小程序,我想从源代码中生成独立的HTML文档,可以在没有godoc服务器的情况下查看。 但我找不到任何方法来实现它。 如果有人能帮助我,我会感激。
一个简单的HTML文档可以被生成,例如:
$ godoc -html container/heap Interface > page.html
更好的forms可以通过以下产生:
$ godoc -url "http://localhost:6060/pkg/container/heap/" > page.html
(我有godoc服务器运行在:6060,我不知道如果这是一个先决条件)。
如果将Go存储库中的原始CSS样式与调整生成的HTML文件以适当地引用它相结合,HTML可能会更好看。
这可能不会直接回答你的问题,但是如果你打算开源你的项目,你并不需要手动生成HTML。 只要确保你的源代码中有正确的注释,并使用godoc.org( http://godoc.org//about )来处理它。
它在Bitbucket,Github,Launchpad和Google Project Hosting上显示Go软件包的文档。
看看这个例子: http : //godoc.org/code.google.com/p/go.crypto/ssh