Beefy Boxes and Bandwidth Generously Provided by pair Networks
Do you know where your variables are?

comment on

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

My touchstone for assisting in deciding what is readable in code is "how (sensibly) close to prose is it?". My justification is that what most of us read most, and are therefore best at parsing, is prose. Applying similar criteria for use of white space and "flow" surely has some benefit.

On the other hand a good friend of mine says that code is more like mathematics and that we should eschew (horizontal) white space where ever possible (although we agree on indentation style).

Before I learned Perl K&R indentation was complete anathema to me and I could see no justification for it what so ever. For Perl K&R seems to be a natural fit and that is what I have come to use. Although readability isn't generally a function of the language, some languages impose their own natural style, some even force a style.

In the past when I was more often proof reading other people's code I would fiddle with the formatting - not because that was "the right way", but because it helped me focus on the structure of the code and more easily grok it. For some reason this seemed to upset some authors. I wonder why? ;)

Some of the OP might be better described as a comentary on "maintainability", rather than "readability" (especially the variables/data structure section), although the two are rather tightly coupled.

DWIM is Perl's answer to Gödel

In reply to Re: What is code readability? by GrandFather
in thread What is code readability? by brian_d_foy

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!
  • 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, 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
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            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?

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

    How do I use this? | Other CB clients
    Other Users?
    Others imbibing at the Monastery: (5)
    As of 2020-07-12 10:02 GMT
    Find Nodes?
      Voting Booth?

      No recent polls found