ASTでドキュメントコメント(Docフィールド)を取得する際にハマった

"go/parser" でパースしたASTから、Docフィールドを取ろうとしてちょっとはまったのでメモ

GitHub のIssueによると ¹
type の前につけたドキュメントコメントは、ast.TypeSpec ではなく、ast.GenDecl の Docフィールドにつくよという話。

// doc comment
type Foo struct {
}

// このコメントは GenDecl.Doc につく
type A struct {
}

// このコメントは GenDecl.Doc につく
type (
    // このコメントが TypeSpec.Doc につく
    B struct {
    }
)

動作確認のソース Gist

1. GitHub Issue go/ast: TypeSpec.Doc is nil? Have to grab documentation at GenDecl #27477 ↩