Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

comment on

( [id://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

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



  • 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.
Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others having a coffee break in the Monastery: (2)
As of 2024-04-24 15:54 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found