Golang输出toml文件时保留原toml注释

有这样一种使用场景，Golang从文件或字符串中读取toml数据并解析，然后进行相应的修改，最后重新写回到文件中，由于一般的toml库不会去特别处理注释，重新生成的toml文件中所有原始的注释都会丢失，以 github.com/BurntSushi/… 为例：

package main  
  
import (  
"log"  
"os"  
  
"github.com/BurntSushi/toml"  
)  
  
func main() {  
  
tomlText := `  
#comment for user  
[user]  
name = "Tom" # comment for name  
age = 30 # comment for age  
`  
var m map[string]interface{}  
if _, err := toml.Decode(tomlText, &m); err != nil {  
log.Fatal(err)  
}  
if err := toml.NewEncoder(os.Stdout).Encode(m); err != nil {  
log.Fatal(err)  
}  
}

以上代码会输出：

[user]
  age = 30
  name = "Tom"

如果需要保留注释，可以使用 github.com/GuanceCloud… 库， 该库是 github.com/BurntSushi/toml 的一个fork分支，对注释做了特别的处理，解析toml数据时会根据一定的规则把注释绑定到相应的key上，之后如果调用库中的新增加的EncodeWithComments()方法，在生成toml时，每遇到一个key，会去查询是否绑定了注释，如果有则在相应的位置输出注释，针对上面的案例，使用 github.com/GuanceCloud/toml 来重写：

package main  
  
import (  
"log"  
"os"  
  
"github.com/GuanceCloud/toml"  
)  
  
func main() {  
  
tomlText := `  
#comment for user  
[user]  
name = "Tom" # comment for name  
age = 30 # comment for age  
`  
var m map[string]interface{}  
meta, err := toml.Decode(tomlText, &m)  
if err != nil {  
log.Fatal(err)  
}  
if err := toml.NewEncoder(os.Stdout).EncodeWithComments(m, meta); err != nil {  
log.Fatal(err)  
}  
}

会输出：

#comment for user
[user]
  age = 30 # comment for age

  name = "Tom" # comment for name

关于注释的绑定规则以及更复杂的使用场景，请参考 github.com/GuanceCloud…