在 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 显示如下，Pre-requisites 不是标题：-

谁能告诉我出了什么问题？

环境：-

Go 1.7
Mac OSX 埃尔卡皮坦

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

在 godoc 中添加标题

Adding a title in godoc

go

godoc