The book of inspiration

April 17, 2009

Code Quality

Filed under: life — Tags: , — zproxy @ 6:36 am

Here is a nice list to indicate the intended code quality from Phil Haack:

  • Prototype Code – Code used to hash out an idea to see if it’s feasible or as a means of learning a new technology. Often very ugly throwaway code with little attention paid to good design.
  • Demo Code – Code used to illustrate a concept, especially in a public setting. Like prototype code, solid design is sometimes sacrificed for clarity, but these sacrifices are deliberate and intentional, which is very important. My jQuery Grid demo above is an example of what I mean.
  • Sample Code – Very similar to demo code, the difference being that good design principles should be demonstrated for the code relevant to the concept the sample is demonstrating. Code irrelevant to the core concept might be fine to leave out or have lower quality. For example, if the sample is showing a data access technique, you might still leave out exception handling, caching, etc… since it’s not the goal of the sample to demonstrate those concepts.
  • Production Code – Code you’re running your business on, or selling. Should be as high quality as possible given your constraints. Sometimes, shortcuts are taken in the short run (incurring technical debt) with the intention of paying down the debt ASAP.
  • Reference Code – This is code that is intended to demonstrate the correct way to build an application and should be almost idealized in its embracement of good design practices.

See also:

Advertisements

3 Comments

  1. […] have already posted about code quality earlier. Comments […]

    Pingback by Code maturity « c# to javascript, actionscript — May 26, 2009 @ 11:22 am

  2. […] following list actually represents the techincal debt of jsc. What if there was a bulldozer that could go ahead an atleast try to mitigate these tasks coming […]

    Pingback by Software Project A Construction Yard « c# to javascript, actionscript — March 5, 2010 @ 7:04 am

  3. Somehow our production code looks more and more like prototype code, which makes me increasingly sad T_T

    Comment by Rei — January 9, 2011 @ 1:48 am


RSS feed for comments on this post.

Sorry, the comment form is closed at this time.

Create a free website or blog at WordPress.com.

%d bloggers like this: