[This is preliminary documentation and subject to change]
Metabase XML comments must be stored in the in-memory metabase and associated with nodes within the metabase, in order for the context of the comments to be preserved during subsequent writes of the metabase to disk. Comments are therefore associated with the node that directly follows the comment.
When loading the metabase, the configuration system will load comments as a generic property into the metabase along with other metabase data. In the case that comments are found at the bottom of the file, below all nodes, that set of comments will always be preserved at the bottom of the file.
Comments are added as follows:
<!-- your comment goes here -->The following is a list of rules concerning metabase comments.
Currently files are written like this:
MetaBase.XML.0000000021.0000000000
and
MetaBase.XML.Error0000000005