GoDoc添加换行符

Question

我知道Golang通过以功能名称（拼写为“ func”）开头的单行注释来支持功能文档。但是，这有一个令人作呕的副作用：具有多个单行注释将不会生成带有换行符的GoDoc，而换行符将文本的每一行分隔开

下面是一张图片来说明：

这是函子及其文档：

//GetFunctionName gets function name
// Parameters:
// - `i` : Function
// **NOTE** this func fails if `i` is a variable set to a func
// (they're called "anonymous functions" in JavaScript)
func GetFunctionName(i interface{}) string {
    return runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()
}

如何在生成的文档中插入换行符？ （如果这是Javadoc，我会很想<br>，那么一切都会很好的。）

Answer 1

插入一个空的注释行，它将是一个新段落，这意味着它将从新行开始：

// GetFunctionName gets function name
//
// Parameters:
//   - `i` : Function
//
// **NOTE** this func fails if `i` is a variable set to a func
// (they're called "anonymous functions" in JavaScript)
func GetFunctionName(i interface{}) string {
    return runtime.FuncForPC(reflect.ValueOf(i).Pointer()).Name()
}

推荐的博客文章：Godoc: documenting Go code

相关部分：

  

Godoc在将注释转换为HTML时使用一些格式化规则：

     

  
• 随后的文本行被视为同一段落的一部分；您必须留空一行以分隔段落。
  
• 预格式化的文本必须相对于周围的注释文本缩进（例如，请参阅gob的doc.go）。
  
• URL将转换为HTML链接；不需要特殊的标记。