A Note On Good Practice
Even though I’ve been developing for some time now it never ceases to amaze me how many people don’t comment in their code. Most of us have fallen into the trap of “the code is self explanatory.” Sure, sometimes it is: if you’re writing “Hello World.” Even that can be questionable at times.
I once interviewed a seasoned developer who, when asked about how they document, replied “I think code should be self documenting.” I wanted to slap my forehead and send them packing right away. Code is never self-documenting. Never. Especially when you go back to it 4 weeks later. And if you think it is self documenting, the poor sap who has to maintain your code doesn’t.
With that said, I would like to make a plea to all non-documenters out there with good reasons on why you want to document.
Why Document? Visual Resting Place
Great …[Read more]