Hello,

I'm interested to see some code header designs that folks are happy with. The standard code header we currently use at my development firm includes places for the Title, Version, Description, 4 lines of copyright notice and contact info, 17 lines of GPL declaration, as well as room for a modification history. So it's about 40 lines total with the modification history is empty, and it grows from there. This is all information that seems worth tracking, but it seems like there is a "better way"-- something captures the interesting information, but in less space perl file.

It seems like so reasonable options include pointing people to central document for more information, and depending on CVS to store and generate some of this information.

So if you've got a code header system you're happy with, I'm interested to hear a description or "screen shot". Thanks!

-mark


In reply to nice styles for code headers by markjugg

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.