StringBuilder builder = new StringBuilder();
string newline = "";
foreach (Map.Entry<MyClass.Key,String> entry : data.entrySet())
{
builder.append(newline)
.append(entry.key())
.append(": ")
.append(entry.value());
newline = "\n";
}Creating Delimited Strings. or: Clean Code vs Readable Code
Today's question: How do I append a newline character for all lines except the last one?
What I really want to talk it about is the subtle difference between clean code and readable code. Take these two samples:
boolean first = true;
StringBuilder builder = new StringBuilder();
for (Map.Entry<MyClass.Key,String> entry : data.entrySet()) {
if (first) {
first = false;
} else {
builder.append("\n"); // Or whatever break you want
}
builder.append(entry.key())
.append(": ")
.append(entry.value());
}Obviously the 2nd snippet shows cleaner code, because there's no messy if/else condition. But is it more readable?
I ask this because although the if/else code is "messy", it's universally understood instantly by almost any developer. On the other hand, you may have to look at the 2nd snippet for a moment to understand how it works. Additionally, the 2nd snippet doesn't declare the delimiter constant until near the end of the block, rather than at the beginning.
Personally I use the latter construct, because the readability difference isn't all large. The pattern just isn't that difficult. But I consider it the lesser of two evils. Also, it shows that it might be possible to cross a line where cleaner code becomes less desirable, even if it works.
