in my experience most code begins its life as prose, whether it is pseudo-code in my head or the pure natural language of CEO/CTO-speak, project notes, task descriptions, PRDs, statements of work, feature requests, bug reports, brainstorming sessions, notebook scribbles, user stories, sprint objectives, and other human-sourced content.
along the way, ideas are translated from the human realm to the human-computer shared-language realm of computer programming. a well-placed comment of intent by a well-meaning but slightly-ignorant ;) co-worker can help reveal that a paragraph of code is mis-implemented.
in my opinion, the "coupling" of comments and code can be a good thing, as long as both are both concise and local. but the purpose of the comments should not be to document the intricacies of your particular choice of implementation, but a general paraphasing of the task at hand.
-
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.
|
