comment in struct

[yesnault]

Hi,

Do you plan to do something like this:

type Postgres struct {
    User     string `comment:"A comment on user"`
    Password string  `comment:"A comment on password"`
}

for

[postgres]
# A comment on user
user = ""
# A comment on password
password = ""

Or is there a way to add comment in output ?

Thks

[yesnault]

with PR, it's that:

type TypeC struct {
	my string
}
type TypeB struct {
	AttrA string  `toml:"user" comment:"A comment on AttrA"`
	AttrB string  `toml:"password" comment:"A comment on AttrB"`
	AttrC string  `toml:"noComment"`
	My    []TypeC `comment:"a comment on My"`
}
type TypeA struct {
	TypeB TypeB `toml:"postgres" comment:"it's a comment on type"`
}

marshall ->

# postgres it's a comment on type
[postgres]
  noComment = "cvalue"

  # A comment on AttrB
  password = "bvalue"

  # A comment on AttrA
  user = "avalue"

  # a comment on My
  [[postgres.My]]

  # a comment on My
  [[postgres.My]]

[yesnault]

type TypeC struct {
		My string `comment:"a comment on my on typeC"`
	}
	type TypeB struct {
		AttrA string  `toml:"user" comment:"A comment on AttrA"`
		AttrB string  `toml:"password" comment:"A comment on AttrB with a\n break line"`
		AttrC string  `toml:"noComment"`
		AttrD string  `toml:"isCommented" commented:"true"`
		My    []TypeC `comment:"a comment on My"`
	}
	type TypeA struct {
		TypeB TypeB `toml:"postgres" comment:"it's a comment on type"`
	}

	ta := []TypeC{{My: "Foo"}, {My: "Baar"}}
	config := TypeA{TypeB{AttrA: "avalue", AttrB: "bvalue", AttrC: "cvalue", AttrD: "dvalue", My: ta}}
	result, err := Marshal(config)

will returns:

# it's a comment on type
[postgres]
  # isCommented = "dvalue"
  noComment = "cvalue"

  # A comment on AttrB with a
  # break line
  password = "bvalue"

  # A comment on AttrA
  user = "avalue"

  # a comment on My
  [[postgres.My]]

    # a comment on my on typeC
    My = "Foo"

  [[postgres.My]]

    # a comment on my on typeC
    My = "Baar"

[pelletier]

Love it! Will review the PR shortly.