在godoc中添加标题

Question

我想在我的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

Answer 1

该列表似乎导致了问题。您可能想为此创建一个问题。

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

// 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