笔记大全

golang 获取注释

更新时间：2023-07-13

背景介绍

在编写程序的时候，注释是非常重要的一部分。它可以为其他开发人员提供代码的解释，帮助他们更好地理解代码的运行逻辑。Golang提供了一种获取源文件注释的方法，这在一些特殊场景下是非常有用的。

方法说明

Golang提供了一个`go/doc`包，其中的`Package`结构体中有一个`Doc`字段，它包含了一个`[]*ast.CommentGroup`类型的切片，每个`ast.CommentGroup`表示一个注释块。我们可以遍历这个注释块来获取到有用的注释信息。下面是一个示例代码：

    package main

    import (
        "go/ast"
        "go/doc"
        "go/parser"
        "go/token"
        "log"
    )

    func main() {
        // 读取源代码
        fset := token.NewFileSet()
        f, err := parser.ParseFile(fset, "example.go", nil, parser.ParseComments)
        if err != nil {
            log.Fatal(err)
        }

        // 构建文档信息
        pkg := doc.New(f, "example", 0)
        for _, typ := range pkg.Types {
            for _, f := range typ.Funcs {
                for _, cg := range f.Decl.Doc.List {
                    log.Printf("comment: %s", cg.Text)
                }
            }
        }
    }

这个例子中，我们读取了名为“example.go”的源代码文件，然后使用`New`函数构建了一个文档对象。我们遍历文档对象中的函数和注释块，将注释的内容打印到命令行中。

注意事项

在获取注释的时候，我们需要注意以下几点：

如果源代码文件中没有注释，那么注释切片的长度为0。
注释块包含注释符号（`//`或`/* */`），我们可以使用`strings.TrimLeft`函数将注释符号去掉。
注释块中可能包含空行，我们可以使用`strings.TrimSpace`函数将空格去掉。

总结

Golang提供了`go/doc`包来获取源代码文件中的注释信息，我们可以使用`Package.Doc`的`[]*ast.CommentGroup`字段来获取注释块。需要注意注释块中可能包含注释符号和空格，需要使用相关函数进行处理。

c语言编程笔录