If it is a configuration file, I really like to also have the unused parameters commented out but in the configuration file, especially if it is a configuration file that I almost never look at, for example the Exim4 mail daemon configuration file.

If it is a configuration file that everybody looks at all the time, all the unused options are known to everybody and only clutter up the file making it hard to see what is really used/active.

I guess what I'm saying is that I can see both approaches having their benefits and you maybe need to investigate further which parts everybody knows and which parts people want/need examples of. Maybe you can move the examples to a different file where people can copy from.

In reply to Re: [OT] What is 'Good Practice' use of an .ini/.conf file: Database or Active Document? by Corion
in thread [OT] What is 'Good Practice' use of an .ini/.conf file: Database or Active Document? by ozboomer

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.