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.
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:
You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
- a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, 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, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.
| & || & |
| < || < |
| > || > |
| [ || [ |
| ] || ] ||