It is perhaps easier to describe "unclean" code. For example:
- Code with lots of code smells (see also wikipedia Code_smell)
- Lots of magic numbers
- A 5000-line main program
- A sub that reads and writes global variables
- A sub that does not have a single purpose; for example, instead of a sin function and a tan function, someone defines a sin_and_tan function
- Some of a sub's parameters are not used
- A sub that is 1000 lines long, aka "Big-Arsed Function"
- Duplicated code
- Code with gaping security holes
- Code that leaks resources
- Code that is not thread-safe or signal-safe
Conversely, some clean Perl code attributes are:
- strict-safe
- warnings-safe
- taint-safe
- Good variable naming
- Minimize variable scope
- Prefer lexicals to globals
- Good commenting
- Consistent indentation and visually pleasing layout
- Easy to understand
- Simple, Clear, General
- Easy to use module interfaces
- Comprehensive test suite
Finally, TheDamian's new book
Perl Best Practices
provides much sound advice on writing clean Perl code.
Update: See also Is it correct? by GrandFather:
- Does it work correctly?
- Do you understand it?
- Would anyone else understand it?
- Will you understand it in a month's time?
- Does it strike a good balance between terseness and verbosity?
- Could you make changes to it without it being likely to break in unforeseen ways?
- Is it fast enough?
Update: See also: On Coding Standards and Code Reviews and Re: I need perl coding standards (Coding Standards References)
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.