go - 在godoc中添加标题

我正在尝试在godoc中添加标题。我已经推荐了godoctricks。我的godoc如下所示:-

// Package hello-world provides a helloworld example
//
// Pre-requisites
//
//  * Go 1.5+
//  * Linux or MacOS
//  * https://onsi.github.io/ginkgo/ for executing the tests
//
//
package hello_world

但是godoc显示如下，但前提条件不是标题:-



有人可以让我知道怎么了吗？

环境:-

Go 1.7

Mac OSX El Capitan

最佳答案

该列表似乎引起了问题。您可能要为此创建一个问题。

如果在列出先决条件之前添加任何行，它将按预期工作:

// Package hello-world provides a helloworld example
//
// Pre-requisites
//
// You need to have the following:
//  * Go 1.5+
//  * Linux or MacOS
//  * https://onsi.github.io/ginkgo/ for executing the tests
//
//
package hello_world

关于go - 在godoc中添加标题，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/39669660/