在godoc中添加一个标题

Question

我正试图在我的godoc中添加一个标题。我已经提到教条主义了。我的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

但是，政府正以以下方式出现，但前提条件不是标题：-

​

​

有人能告诉我出了什么问题吗？

环境：-

• 去1.7
• Mac 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