在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作为下面显示了先决条件还不如标题： -

有人可以让我知道了什么错误？

环境： -

• 围棋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