Paul Graham has a good article on Taste at
Taste for Makers. I would strongly suggest that everyone read it (and the rest of his articles, for that matter).
I think that most pretty/well-dressed code has a few common characteristics. Many of these characteristics overlap, which is a good sign that they will probably be describing the same thing.
- It's well-factored
- It's easier to read than other implementations
- Variables are well-named
- There's a minimum of abstract units
- Those abstract units are well-documented
- Any deviation from these characteristics is well documented and explained
Basically, if I have to wonder what you did and/or why you did it, that's a problem. If I have to parse through $aa, $aaa, and $aaaa (which is actually in some code I haven't been given permission to rewrite yet) ... that's a bigger problem.
Prettiness is predicated upon usability.
------
We are the carpenters and bricklayers of the Information Age.
Then there are Damian modules.... *sigh* ... that's not about being less-lazy -- that's about being on some really good drugs -- you know, there is no spoon. - flyingmoose
I shouldn't have to say this, but any code, unless otherwise stated, is untested
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.