views:

328

answers:

4

Is it OK to put comments before the XML declaration in an XML file?

<!--
Is this bad to do?
-->
<?xml version="1.0" encoding="utf-8"?>
<someElement />
+6  A: 

No, it's not OK.

Appendix F of the XML spec says:

Because each XML entity not accompanied by external encoding information and not in UTF-8 or UTF-16 encoding must begin with an XML encoding declaration, in which the first characters must be '< ?xml', any conforming processor can detect, after two to four octets of input, which of the following cases apply.

Ah, but, section F is non-normative, you say.

Well, section 2.1 gives the production for a well-formed XML document, thus:

[1]     document    ::=     prolog element Misc*

...and in section 2.8 we get the production for "prolog":

[22]    prolog    ::=     XMLDecl? Misc* (doctypedecl Misc*)?
[23]    XMLDecl    ::=    '<?xml' VersionInfo EncodingDecl? SDDecl? S? '?>'

So, you can omit the < ?xml declaration, but you can't prefix it with anything.

(Incidentally, "Misc" is the category that comments fall into).

Gary McGill
+1 for the most thorough and official answer
rmeador
+8  A: 

according to this page, this is illegal.

Atmocreations
Can you get arrested?
emddudley
I was beaten and put in a Singapore jail cell for this!
Chap
+5  A: 

The XML declaration specifies the document encoding, which is as important for comments as for structural XML. Therefore, the declaration should go first. I wouldn't be surprised if many XML readers were able to deal with this, but it's a bad idea.

jlew
well, i agree with you. in fact the parser must have an idea how to read the document as he wouldn't be able to read the encoding neither. therefore only putting multi-byte characters into this comment should be disallowed...
Atmocreations
A: 

No, this does not comply with XML standards, but comments are good.

Joshua Louden