3 ms·
I'd be interested to see what his code looked like and how the code reviews progressed before firing him. I think these discussions are important, however, we m
by Denzel 9y ago
I'd be interested to see what his code looked like and how the code reviews progressed before firing him. I think these discussions are important, however, we must ground them in a concrete reality. That's what I appreciated about Clean Code, it was grounded in addressing real live code. And the reader is able to choose whether they agree with the conclusions or not.
With that said, all too often, like in this article, we get caught up in cute hypothetical scenarios an examples. There were no real-world examples given, just a bunch of hand-waving.
So in the interest of moving the discussion forward in a concrete way, I'd ask you what you think of these three C lexers; one written in Go by yours truly, GCC's, and LLVM's:
1. https://github.com/denzel-morris/clex/blob/master/lex/lexer.go https://github.com/denzel-morris/clex/blob/master/lex/lexer....
2. https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=gcc/c-family/c-lex.c;h=3765a800a5799209bca5018dd36c9f3c53525b8f;hb=HEAD https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=gcc/c-family/c-l...
3. https://github.com/llvm-mirror/clang/blob/master/lib/Lex/Lexer.cpp https://github.com/llvm-mirror/clang/blob/master/lib/Lex/Lex...
I always find it helpful to look at one problem solved different ways. Of course it's not always apples-to-apples but it's as close as you're going to get. Out of these three codebases, there is probably one you'd feel more comfortable working with. I merely threw mine in there because I wrote it as an exercise on what it'd be like to have a hand-written lexer read more like a story.
It has a focused interface, most functions are descriptively named and operate at a single-level of abstraction, and it's easy to intuit what a C lexer does even if you're not familiar with what they're supposed to do. I'm sure it'd be easy for most people to jump into my code and contribute.
Just like with LLVM's lexer. LLVM is far easier to jump in and contribute to than GCC.
However, and this is just an example that immediately jumps out to me since we're talking about it... doesn't it make sense to have this comment and code abstracted out into a respectively descriptive function instead:
void Lexer::InitLexer(const char *BufStart, const char *BufPtr,
const char *BufEnd) {
// ...
// Check whether we have a BOM in the beginning of the buffer. If yes - act
// accordingly. Right now we support only UTF-8 with and without BOM, so, just
// skip the UTF-8 BOM if it's present.
if (BufferStart == BufferPtr) {
// Determine the size of the BOM.
StringRef Buf(BufferStart, BufferEnd - BufferStart);
size_t BOMLength = llvm::StringSwitch<size_t>(Buf)
.StartsWith("\xEF\xBB\xBF", 3) // UTF-8 BOM
.Default(0);
// Skip the BOM.
BufferPtr += BOMLength;
}
// ...
}
I mean think about it... we're concerned with initializing the lexer, why am I being bothered with this string manipulation minutia to determine whether there's a BOM or not? That could be extracted into a properly named function, the comment eliminated, and then I could trust that that function does exactly what it says on the tin can.
And there's plenty more places where this line of reasoning applies too.
Jekyll (https://github.com/jekyll/jekyll https://github.com/jekyll/jekyll) is another example of a codebase that's very easy to read, work with, modify, etc. It's very well-written. It follows Clean Code like principles where it makes sense.
On the other side of the coin we have Kubernetes (https://github.com/kubernetes/kubernetes https://github.com/kubernetes/kubernetes) which looks ready to collapse under its own complexity. It's supremely difficult to read and understand what's going on not because of the essential complexity of the problem but because of all the incidental complexity added by the code structure.
I could spend forever citing examples on both sides because I've spent a great deal of time thinking about this and talking with other seasoned developers.
If you (or anyone really) could, please offer up concrete examples grounded in real production code. I'm always interested to see more examples.
Specifically examples blind Clean Code dogmatism applied in the wild.
- mdpopescu 9y agoI don't know Go, but your example looks absolutely beautiful. On the other hand, I'm one of those "smaller than that" people :) I mean, I am ashamed that I left the time-to-string function in [1] too long. It could definitely be split up (and I find value in that, I just haven't had time / a reason to revisit that code). [1] https://github.com/mdpopescu/public/blob/master/SocialNetwork/SocialNetwork.Library/Services/TimeFormatter.cs https://github.com/mdpopescu/public/blob/master/SocialNetwor...
- Denzel 9y agoThank you, I really appreciate that. I understand exactly how I feel. I think your way of attacking it is the right way -- pragmatism. You realize it can be improved/split but (1) you haven't had time, (2) there's been no reason to revisit the code, and (3) it's serving its purpose. That makes sense to me. It takes time. Time and many passes to refactor code. The idea being that as a developer becomes more experienced: the amount of time and the number of passes should begin to decrease. At least that's the idea.