Try to match the header complexity to the program, though. Using this header for a program that consists of one line of code might be a little bit of overkill. I usually start with the two-line header and expand it as I see fit.
Oh, I got to ask this. What will be the two lines you start with, and how large does your program need to grow before you add, say, the name of the author, a paragraph about usage, or a version on it? If you expand it, in which order do you add the things your example has?
Whether I slab on comments like author, version, date, usage, etc, on a program has all to do with the purpose and intended usage of the program. And nothing at all to do with its length.
-
Are you posting in the right place? Check out Where do I post X? to know for sure.
-
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big>
<blockquote> <br /> <dd>
<dl> <dt> <em> <font>
<h1> <h2> <h3> <h4>
<h5> <h6> <hr /> <i>
<li> <nbsp> <ol> <p>
<small> <strike> <strong>
<sub> <sup> <table>
<td> <th> <tr> <tt>
<u> <ul>
-
Snippets of code should be wrapped in
<code> tags not
<pre> tags. In fact, <pre>
tags should generally be avoided. If they must
be used, extreme care should be
taken to ensure that their contents do not
have long lines (<70 chars), in order to prevent
horizontal scrolling (and possible janitor
intervention).
-
Want more info? How to link
or How to display code and escape characters
are good places to start.
|
