Added optional comment handling

[visorgames]

XML-Comments can now be parsed or build.
The comments can be accessed via the commentskey (default: $comments) under their parent node.
To activate this feature, the option parseComments has to be set to true.

To support multiple comments contained in the same tag, the comments are pushed to an array like any other node. Comments are only parsed if they are at least inside the root node.
The position of comments in the xml is only reliably preserved if they are not placed in between child tags with the same name (eg.: <test>...</test><!-- comment --><test>...</test>) or are split by an other child tag (eg.: <!-- comment1 --><test/><!-- comment2 -->). Otherwise the original xml-structure can be rearranged, as nodes with the same tag-name get parsed into an array.

This feature was already requested in the past: #44, #475

[coveralls]

Coverage increased (+0.09%) to 97.727% when pulling 0bdbcce on visorgames:master into 0f0a298 on Leonidas-from-XIV:master.

[coveralls]

Coverage increased (+0.09%) to 97.727% when pulling 0bdbcce on visorgames:master into 0f0a298 on Leonidas-from-XIV:master.

[ainthek]

+1 when will this be available please ?

[Leonidas-from-XIV]

There is no plan for it at the moment.

[mastakillahBlitzar]

How can we contribute to pull this through ? very helpful

[TaroXin]

@Mask

How can we contribute to pull this through ? very helpful

I found a library that is better adapted and also supports comments parsing, https://github.com/oozcitak/xmlbuilder2

I have seen the information you left from many libraries, I believe you are also very anxious