tagged by: clean code
To Be Explicit
Often designs techniques are used to make a system more flexible, but end up being harder to work with. One of the reasons is that explicitness is a property that often gets forgotten in design.
November 2001
When to Make a Type
Guidelines on when to make a new user defined type (or class) for values.
January 2003
CommandQuerySeparation
The term 'command query separation' was coined by Bertrand Meyer
in his book "Object Oriented Software Construction" - a book that is
one of the most influential OO books during the early days of
OO. (The first edition is the one that had the influence, the second
edition is good but you'll need several months in a gym before you
can lift it.)
5 December 2005
bliki
DataClump
Whenever two or three values are gathered together - turn them into a $%#$%^ object.
-- Me (it was funnier with the voices)
This is one of my favorite CodeSmells from the refactoring book. You spot it when you constantly see the same few data items passed around together. start and end are a good example of a data clump wanting to be a range. Often data clumps are primitive values that nobody thinks to turn into an object.
bliki
Detestable
(Here's an addition to your dictionary.)
Detestable (adjective): software that isn't testable.
16 March 2005
bliki
SelfTestingCode
Self Testing Code is the name I used in Refactoring to refer to the practice of writing comprehensive automated tests in conjunction with the functional software. I come across it primarily with tools like the XUnit family of testing frameworks.
bliki
TestDrivenDevelopment
Test Driven Development (TDD) is a design technique that drives the development process through testing. In essence you follow three simple steps repeatedly:
5 March 2005
bliki
Using Metadata
You can use metadata based approaches to remove the pain from tedious data oriented tasks.
November 2002
CodeSmell
A code smell is a surface indication that usually corresponds to a deeper problem in the system. The term was first coined by Kent Beck while helping me with my Refactoring book.
bliki
ComposedRegex
One of the most powerful tools in writing maintainable code is break large methods into well-named smaller methods - a technique Kent Beck refers to as the Composed Method pattern.
24 July 2009
bliki
DesignStaminaHypothesis
From time to time I have indirect conversations about whether good software design is a worthwhile activity. I say these conversations are indirect because I don't think I've ever come across someone saying that software design is pointless. Usually it's expressed in a form like "we really need to move fast to make our target next year so we are reducing <some design activity>".
20 June 2007
bliki
GangOfFour
In my view the Gang of Four is the
best book ever written on object-oriented design - possibly of any
style of design. This book has been enormously influential on the
software industry - just look at the Java and .NET libraries which are
crawling with GOF patterns.
bliki
TechnicalDebt
You have a piece of functionality that you need to add to your system. You see two ways to do it, one is quick to do but is messy - you are sure that it will make further changes harder in the future. The other results in a cleaner design, but will take longer to put in place.
26 February 2009
bliki
