正如其他人所指出的,cmets 中的“列表”不会转换为 HTML 列表(例如 <ol>、<ul>)。
推荐阅读:Godoc: documenting Go code。引用自它:
Godoc 在概念上与 Python 的 Docstring 和 Java 的 Javadoc 相关,但它的设计更简单。 godoc 读取的 cmets 不是语言结构(与 Docstring 一样),它们也不一定有自己的机器可读语法(与 Javadoc 一样)。 Godoc cmets 只是很好的 cmets,即使 godoc 不存在,您也会想阅读的那种。
生成 HTML 文档时仅执行以下转换:
Godoc 在将 cmets 转换为 HTML 时使用了一些格式规则:
- 随后的文本行被视为同一段落的一部分;您必须在段落之间留一个空行。
- 预格式化文本必须相对于周围的评论文本缩进(参见 gob 的 doc.go 示例)。
- URL 将被转换为 HTML 链接;不需要特殊标记。
你可以做什么来“模仿”列表:
使用以下注释:
// Fv1 is just an example.
//
// Here's a list:
//
// -First item
//
// -Second item
//
// -Third item
//
// This is the closing line.
结果如下:
Fv1 只是一个例子。
这是一个列表:
-第一项
-第二项
-第三项
这是结束语。
提供更好视觉外观的细微变化是使用项目符号 • 字符而不是破折号:
// Fv1 is just an example.
//
// Here's a list:
//
// • First item
//
// • Second item
//
// • Third item
//
// This is the closing line.
导致(github.com/google/go-cmp 使用它):
Fv1 只是一个例子。
这是一个列表:
• 第一项
• 第二项
• 第三项
这是结束语。
或者您可以缩进列表项(1 个额外的空间就足够了,但您可以根据自己的喜好使用更多空间):
// Fv2 is just another example.
//
// Here's a list:
// -First item
// -Second item
// -Third item
//
// This is the closing line.
在生成的文档中产生这个:
Fv2 只是另一个例子。
这是一个列表:
-First item
-Second item
-Third item
这是结束语。
您可以像这样创建“嵌套”列表,保留标识(因为它将是一个预先格式化的块):
// Fv3 is just another example.
//
// Here's a list:
// -First item
// -First.First item
// -First.Second item
// -Second item
//
// This is the closing line.
文档中的结果:
Fv3 只是另一个例子。
这是一个列表:
-First item
-First.First item
-First.Second item
-Second item
这是结束语。