CSC/ECE 517 Summer 2008/wiki2 5 31
DRY Principle
The Don't Repeat Yourself (DRY) principle is basic to writing maintainable code. The purpose of this Wiki is to find Web sites that explain the importance of the principle by writing prose that summarizes their arguments. Examples whill be provided of where the principle should be applied. A checklist will be created for programmers to consider in determining whether their code is in conformance.
What is the DRY Principle?
The DRY code philosophy is stated as every piece of knowledge must have a single, unambiguous, authoritative representation within a system.
The Importance of the DRY Principle?
DRY, is also known as Single Point of Truth. This process is aimed at simplifying the maintenance of code. The philosophy emphasizes that information should not be duplicated, because duplication increases the difficulty of change, may decrease clarity, and leads to opportunities for inconsistency. When the DRY principle is applied successfully, a modification of any single element of a system does not change other logically-unrelated elements. Additionally, elements that are logically related all change predictably and uniformly, and are thus kept in sync.
Examples of the DRY Principle?
Inadvertently, you may introduce duplication into your model without realizing that you are doing so. Suppose you have a class that represents a line as follows:
class line {
public:
Point start;
Point end;
double length;
};
Although this may appear to be a reasonable class for defining a line but we have duplication. If for example we store the start and end points and then the length we will have a problem if one of the points changes. The length will be incorrect. It would be much better to have the length be calculated from the existing start and end points.
class line {
public:
Point start;
Point end;
double length() { return start.distanceTo(end); }
};
Now we are not duplicating any information in our class and are following the principle of Don't Repeat Yourself.