It depends on the sophistication of the audience: who will read and maintain the code?
Contractions and shortcuts can add clarity, but they can be over done.
Just as with natural language, double negatives, complicated compound clauses, and large distances between the referred and the referrent -- or, as this interruption demonstrates, mid-sentence diversions, within long rambling sentences that try to do too much and thus don't do it well, compared to simpler structure -- can all serve to make a the reader of code or of prose work harder, and possibly make mistakes.
print "foo!" unless /\S/; # too many negatives
if (grep {is_important{$_}} map {mangle{$_}} $obj->method; # too compl
+icated, too much span
{
#begin brace1
{
#begin brace2
{
#begin brace3
...
#begin brace-n
# too much nesting!
# and so forth
water
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: |
| & | | & |
| < | | < |
| > | | > |
| [ | | [ |
| ] | | ] |
Link using PerlMonks shortcuts! What shortcuts can I use for linking?
See Writeup Formatting Tips and other pages linked from there for more info.