`go/doc/comment`

Guided tour · Go Tooling · pkg.go.dev →

Parse and print the new-style (Go 1.19+) doc comment syntax — with headings, lists, links, and code blocks.

Usage

Parse + print as text/HTML/Markdown

var p comment.Parser
doc := p.Parse("// # Heading\n// See [fmt.Println] for details.")
var pr comment.Printer
fmt.Println(string(pr.Text(doc)))
fmt.Println(string(pr.Markdown(doc)))
fmt.Println(string(pr.HTML(doc)))