파서가 유형 구조에 대한 주석을 감지할 수 없는 이유는 무엇입니까?

Go 파서가 유형 구조에 대한 주석을 감지하지 못합니다

질문

Go의 파서 및 ast 패키지를 사용하여 구조체 유형과 관련된 문서 주석을 추출하려고 할 때, 유형 구조 자체에 대한 주석을 찾을 수 없습니다. 함수 및 필드에 대한 주석은 있지만 FirstType 및 SecondType이라는 유형에 대한 문서가 누락되었습니다.

근본 원인

이 문제는 Go 파서의 기본 구문 분석 동작이 그렇지 않기 때문에 발생합니다. 문서 주석을 AST(추상 구문 트리)의 TypeSpec 노드와 연결합니다. TypeSpec을 발견하면 파서는 현재 모든 Doc 주석 노드를 사용하고 이를 AST에서 제거합니다.

솔루션

순수한 AST로 주석을 구문 분석

for _, f := range d {
    ast.Inspect(f, func(n ast.Node) bool {
        switch x := n.(type) {
        case *ast.FuncDecl:
            fmt.Printf("%s:\tFuncDecl %s\t%s\n", fset.Position(n.Pos()), x.Name, x.Doc.Text())
        case *ast.TypeSpec:
            fmt.Printf("%s:\tTypeSpec %s\t%s\n", fset.Position(n.Pos()), x.Name, x.Doc.Text())
        case *ast.Field:
            fmt.Printf("%s:\tField %s\t%s\n", fset.Position(n.Pos()), x.Names, x.Doc.Text())
        case *ast.GenDecl:
            fmt.Printf("%s:\tGenDecl %s\n", fset.Position(n.Pos()), x.Doc.Text())
        }

        return true
    })
}

사례 추가 ast.GenDecl의 경우 AST 검사 기능에 적용됩니다. 이는 유형 정의가 여러 개별 정의의 축약인 특별한 경우에 유형 정의에 대한 주석이 저장되는 GenDecl 노드와 연관된 문서 주석을 확인합니다.

그러나 이 접근 방식은 만족스럽지 않습니다. 문서 주석은 AST의 해당 TypeSpec 노드에 첨부되지 않습니다.

선호 솔루션: go/doc 사용

import (
    "go/doc"
)

func main() {
    d, err := doc.ParseDir("./", nil, doc.AllDecls)
    if err != nil {
        fmt.Println(err)
        return
    }

    for _, info := range d {
        ast.Inspect(info.Decl, func(n ast.Node) bool {
            switch x := n.(type) {
            // ... inspecting cases for functions, fields, etc.
            case *ast.TypeSpec:
                fmt.Printf("%s:\tTypeSpec %s\t%s\n", fset.Position(n.Pos()), x.Name, info.Doc)
            }

            return true
        })
    }
}

go/doc를 사용하면 표준화되고 포괄적인 구문 분석 및 검색 방법이 제공됩니다. 구조체 유형을 포함한 모든 유형에 대한 문서 주석입니다. 문서 주석이 GenDecl 노드에 첨부되는 경우를 처리하고 AST의 해당 노드와 주석의 적절한 연결을 보장합니다.

위 내용은 파서가 유형 구조에 대한 주석을 감지할 수 없는 이유는 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!