Great Moments in Documentation II

By Xenoveritas, 16 December, 2004
Topics
Technology

Again, the details have been changed to protect the guilty.

The example below shows the format of an example file, configuration.xml.
Explanations for fields are included as comments:

<?xml version="1.0"?>
<configuration>
  <settings>
//Settings to be used by the system
    <database>
       <info>
          <name>Name</name>
... and so on

Ummm......

  1. That's XML. "//" isn't an XML comment. "<!-- -->" is. You do know XML, right? Please?
  2. There really was only one comment, before any actual data, which didn't explain any of the options, at all. That was it.

*sigh*