I really appreciate the question and, while being no master, will give some of my own crutches.

The first crutch is seeking peer-review, even if said peer isn't really your peer, but your better in the given field.
There are monks around, who breathe, what I'striving for. To get their critical comments is a premium. If one isn't willing to post ones code to the monastery -- due of whatever reasons. Mine are false pride and cowardice. -- one can go for peers in an more familiar, more comfortable environment that an online community might provide.
Personal note: I dare to discuss most of my code with the two developers at my site. That's good. But I know, when I'm able to face the wrath -- or more plausibly the giggle -- of my fellow monks, my personal maturation has done a quantum leap -- and my code will follow suite.

The second crutch is commenting. Don't go for the meaning of "comment" in an arbitrary programming language (and drop that lore of "real programmers don't comment" -- I rather like to be a good programmer instead of a real one, if those a the choices), but go for the meaning of "comment" in the press. There, a comment is an opinion -- or, at least, an opinionated summary -- of a factual event.
The first comment, I wrote, is my opinion, what the code should do, what I dreamed of its functionality. Sometimes, while writing down those fantasies, I'll see my error in plain language. The second comment isn't a comment following the above definition, but a report. It merely state, what my code has done in a test run.
Now for the hard part: Leave those comments in your code. It's much easier to follow ones intention, if the path from imagination to reality is laid down. As a consultant, who had to review some of my programm, once said after serveral time silently staring on the screen: "Whatever you smoke, I want some of it."


In reply to Re: Meaning of Maintanability and Functionality in Coding Perl by martinvi
in thread Meaning of Maintanability and Functionality in Coding Perl by neversaint

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!
  • 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:
    & &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.