在go函数注释中编写代码块的正确方法是什么

Question

我想在函数的注释中包含一些示例代码，如下所示：

// Some example for using `foo`:
//
// ```
//   f := Foo(...)
//   g := Goo(f)
// ```
func Foo() {
...
}

但是代码块在vscode中没有正确显示。做这件事的正确方法是什么？

Answer 1

删除这些backtick并缩进代码：

// Foo does ... (note this first line)
// Some example for using Foo:
//
//   f := Foo(...)
//   g := Goo(f)
func Foo() {
...
}

引用Go博客：Godoc:记录Go代码：

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

• 文本的后续行被视为同一段落的一部分；你必须留出一行空白来分隔段落
• 预先格式化的文本必须相对于周围的注释文本缩进(有关示例，请参阅gob的doc.go(
• URL将被转换为HTML链接；不需要特殊标记

相关问题：

Godoc文档未输出列表

GoDoc添加换行符

Go示例函数是什么？