Comments for Documenting XML Entities

I’ve seen people documenting XML entities with comments before the entity definition:

<DOCTYPE root [ <!-- Some Documentation here --> <!ENTITY foo "bar"> ]> 

In some editors (e.g. Oxygen XML), when hovering over the entity, the documentation would be displayed in a popup window.

This behaviour seems very reasonable to me. However I could not find any information, if that is officially how entities are documented or if that’s just how some people do it.
Is there any (maybe even W3C) authoritativ document on how entities should be documented?

Add Comment
0 Answer(s)

Your Answer

By posting your answer, you agree to the privacy policy and terms of service.