为什么在解码golang yaml时头注释变成了尾注释

大家好，今天本人给大家带来文章《为什么在解码golang yaml时头注释变成了尾注释》，文中内容主要涉及到，如果你对Golang方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

我正在通过下面非常简单的代码使用 headcomment 进行测试：

package main

import (
    "fmt"
    "gopkg.in/yaml.v3"
)

type person struct {
    name *yaml.node
}

func main() {
    namenode := &yaml.node{
        kind:        yaml.scalarnode,
        headcomment: "the name of a person",
        value:       "lily",
        style: yaml.doublequotedstyle,
    }

    person := person{
        name: namenode,
    }

    datainbytes, _ := yaml.marshal(person)
    fmt.println(string(datainbytes))
}

我期望看到这样的输出：

# the name of a person
name: "lily"

但是，我得到了：

name: "Lily"
# The name of a person

头部注释变成脚部注释。有人有想法吗？谢谢！

https://play.golang.org/p/10bqt2ktkbu

解决方案

发生这种情况是因为该头注释附加到 yaml 文档树中的值节点（不是 name:，而是 "lily"）。

因此，当事件被发出时，评论实际上属于：

name: "lily"
     ^-- here

go-yaml 将值的标题注释放在对的末尾，这有点有意义。我将其称为实现，而不是预期的行为，所以最好您已经向库作者打开了一张票，看看他们是否想要更改实现并将 key: value 对中的 value 的头注释移动到标题的位置改为 key 的评论（我同意，特别是在用于编组结构时，这是有意义的并且更方便）。

下面是一个代码示例，它创建相同的结构并向 name: 键添加头注释，而不是获得正确的渲染（以丢失漂亮的结构为代价）：

func main() {
        key := &yaml.node{
                kind:        yaml.scalarnode,
                value:       "name",
                headcomment: "the name of a person",
        }
        value := &yaml.node{
                kind:  yaml.scalarnode,
                value: "lilly",
                style: yaml.doublequotedstyle,
        }

        mapping := &yaml.node{
                kind:    yaml.mappingnode,
                content: []*yaml.node{key, value},
        }

        datainbytes, _ := yaml.marshal(mapping)
        fmt.println(string(datainbytes))
}

输出：

# The name of a person
name: "Lilly"

以上就是《为什么在解码golang yaml时头注释变成了尾注释》的详细内容，更多关于的资料请关注golang学习网公众号！