While nobody likes to write or read excessive storybook comments and while the structure of a storybook (or top-down) program is equally uninteresting and simplistic (perhaps it may be too verbose), my opinion is that these dull practices make it simpler for *other* people to maintain your code. *Other* people are not always as brilliant as you or I and they don't have the same knowledge of your code that you have. Since you may be hit by a bus someday, you owe it to your clients to employ these dull and sometimes patronizingly simple programming techniques.
I like chicken.
-
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.
|