Follow

There's a lot of discussion among coders about comments, some say that good code shouldn't need commenting.

But the thing a lot of people fail to understand with comments is that you don't just want to say what th code is doing. But why. The why is often more important. I have a code base I've taken over maintenance of, and in the execution there's a 60 second delay in there. But there's no details of why. What breaks if I remove it? Do I want to find out the hardway?

· · Web · 4 · 2 · 10

@quixoticgeek that 60 second sleep should be in a seperate function with a revealing and human readable function name 😀 #extremeprogramming

@quixoticgeek Also, high quality commit messages in (VCS of choice)...

@quixoticgeek Only if the lines following it are an explanation of why FFS :D

@quixoticgeek "You may wonder why we're toggling /CS after every byte. It's because the datasheet is lying and whichever idiots designed this chip didn't understand SPI at all" may have been one I've put in my code.

Think I saw someone else complaining about the same thing recently. No idea if it was the same chip.

Sign in to participate in the conversation
(void *) social site

(void*)