Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) Need Help??

To me, the only consideration is that:   the code must be obvious and consistent.   Every “shop” will develop “accepted practices,” and the most important thing that you must do is to follow them.   Source code size is not a consideration.   The computer is blisteringly fast.   Disk space is unlimited.   If you can’t type, hire a typist.

Anyone who looks at your code must be able to understand at a glance what it is doing, and their “glance” must be correct.   Remember that people see what they expect to see, as demonstrated by this old chestnut:

PARIS IN THE THE SPRING
PARIS IN THE SPRING,” right?   Look again.

So, “the correct style” is to first find out how your shop is writing such things now, and then to proceed to do it in exactly the same way.   Otherwise, find what is the most abundantly clear way to write it... which is usually not the most brief.

Finally, always consider changes.   The code that you write will one day be changed, probably in a hurry, probably not by you.   Does “a slight change” to your code “break it?”   Especially... does it “break it” in such a way that it no longer works as intended, but also does not produce a syntax-error?   The consequences of any such change can be disastrous.


In reply to Re: A matter of style: how to perform a simple action based on a simple condition? by sundialsvc4
in thread A matter of style: how to perform a simple action based on a simple condition? by muba

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • 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, 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
  • Outside of code tags, you may need to use entities for some characters:
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others musing on the Monastery: (5)
    As of 2014-11-24 01:50 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      My preferred Perl binaries come from:














      Results (135 votes), past polls