Comment support? about simple-yaml HOT 2 CLOSED

Yes, with some considerations.

You can load a file with comments inside, make changes and then save your YamlFile using method saveWithComments instead usual save, in the same file or another one. This is more time-consuming than save, so if you don't need comments save is recommended.

Note that comments to the right of key/values are NOT copied, only those lines starting with # character, ignoring tabs and spaces:

# this comment will be copied
number: 2 # this comment will NOT be copied

from simple-yaml.

A new release is available (1.5) with improved support for comments.

Side comments are now supported.

# this comment will be copied
number: 2 # this comment now will be copied too

Note, though, when going to use comments you must use saveWithComments instead of save. In addition, when adding comments via code loadWithComments should be used too instead of load to preserve comments that may already exist.

from simple-yaml.