Godooc 无法解析我的代码或无法解析匿名函数？

在使用 Godoc 记录 Go 代码时遇到问题，具体表现为 Godoc 无法解析代码中的匿名函数，导致这些函数的文档无法呈现。为了解决这个问题，可以参考 Godoc 官方文档中的建议，在 Godoc URL 中添加 "&m=all" 参数，强制 Godoc 记录所有声明，包括非导出方法。此外，还可以使用其他记录 Go 代码的工具或技巧，如 `go doc -all` 命令或第三方工具。

最近我尝试记录我的代码，但在使用 godoc 时遇到了一些麻烦，因为当我运行 godoc -http:localhost:6060 时，有些功能没有出现

这就是我的代码：

type MongoDBInterface interface {
    ExecuteTransaction(operation func(mongoClient MongoDBInterface) error) error
    Count(tableName string, clause bson.M) (int, error)
    Distinct(tableName, fieldName string, clause bson.M) ([]interface{}, error)
    InsertOrUpdate(tableName string, clause bson.M, data models.BaseModelInterface) (primitive.ObjectID, error)
    InsertOrUpdateFields(tableName string, clause bson.M, data interface{}) (primitive.ObjectID, error)
    Insert(tableName string, data models.BaseModelInterface) (primitive.ObjectID, error)
    Update(tableName string, clause bson.M, data models.BaseModelInterface) error
    UpdateFields(tableName string, clause bson.M, data interface{}) error
    FindOne(tableName string, clause, opt bson.M, result interface{}) error
    FindMany(tableName string, clause, opt bson.M, result interface{}) error
    Truncate(tableName string) error
    Delete(tableName string, clause bson.M) error
    Aggregate(tableName string, pipelines interface{}, result interface{}) error
    EnsureCollections() error
}

type mongoDB struct {
    session              mongo.Session
    db                   *mongo.Database
    ctx                  context.Context
    isTransactionEnabled bool
    isConnected          bool

    connString string
}

// NewMongoDB definition
func NewMongoDB() MongoDBInterface {
    mongoClient := new(mongoDB)
    mongoClient.ctx = context.Background()

    dbHost := os.Getenv("DB_HOST")
    if dbHost == "" {
        dbHost = "localhost"
    }
    dbUser := os.Getenv("DB_USERNAME")
    if dbUser == "" {
        dbUser = "dbadmin"
    }
    dbPswd := os.Getenv("DB_PASSWORD")
    if dbPswd == "" {
        dbPswd = "dbpassword"
    }
    dbName := os.Getenv("DB_NAME")
    if dbName == "" {
        dbName = "dbname"
    }
    dbAuth := os.Getenv("DB_AUTH")
    if dbAuth == "" {
        dbAuth = "admin"
    }
    dbMode := os.Getenv("DB_MODE")
    if dbMode == "" {
        dbMode = "admin"
    }

    // temporary
    connString := fmt.Sprintf("mongodb+srv://%s:%s@%s/%s?retryWrites=true&w=majority", dbUser, dbPswd, dbHost, dbName)
    mongoClient.connString = connString

    return mongoClient
}

// connect to mongodb server
func (s *mongoDB) connect() error {
    // get query string from env,
    // then parse it to get db name

    // connString := os.Getenv("MONGODB_CONN_STRING")
    connString := s.connString
    log.Println("ConnString =>", connString)

    parts := strings.Split(connString, "/")
    dbName := strings.Split(parts[len(parts)-1], "?")[0]

    // prepare options object for connecting to mongodb
    opt := options.Client()
    opt.ApplyURI(connString)

    // set the timeout info from data defined in the env
    // timeout, _ := strconv.Atoi(os.Getenv("MONGODB_TIMEOUT_IN_SECOND"))
    timeout := 120
    timeoutDuration := time.Duration(timeout) * time.Second
    opt.ConnectTimeout = &timeoutDuration

    // create client object
    client, err := mongo.NewClient(opt)
    if err != nil {
        log.Println(err.Error())
        return err
    }

    // connect to the db server
    err = client.Connect(context.Background())
    if err != nil {
        log.Println(err.Error())
        return err
    }

    // start new session
    session, err := client.StartSession()
    if err != nil {
        log.Println(err.Error())
        return err
    }

    // store session and db info into props
    s.session = session
    s.db = client.Database(dbName)
    s.isConnected = true

    log.Println("Connected to database")

    return nil
}

问题是 godoc 永远不会呈现 func (s *mongodb) connect() 错误 但我需要将其记录下来，你们能给我解释一下 godoc 发生了什么吗？或者您可以给我一些记录 go 代码的解决方案和技巧。

正确答案

您可以参考这个文档：https://pkg.go.dev/golang.org/x/tools/cmd/godoc

The presentation mode of web pages served by godoc can be controlled with the "m" URL parameter; it accepts a comma-separated list of flag names as value:

- all   show documentation for all declarations, not just the exported ones
- methods   show all embedded methods, not just those of unexported anonymous fields
- src   show the original source code rather than the extracted documentation
- flat  present flat (not indented) directory listings using full paths

For instance, https://golang.org/pkg/math/big/?m=all shows the documentation for all (not just the exported) declarations of package big.

?m=all 记录所有声明，包括非导出方法

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《Godooc 无法解析我的代码或无法解析匿名函数？》文章吧，也可关注golang学习网公众号了解相关技术文章。