You think your code is so clean that it doesn't need any comments? Or are your colleagues convinced that all comments are failures? Then this talk is for you!
Let's first dispute some common arguments against commenting code:
- Comments lie?
- Tests are better?
- Good names suffice?
We find fault with all of them (and more)!
With that out of the way we categorize comments and analyze their costs and benefits. This wills us the means to discuss the end: Which comments will improve a code base?
Of course, every team has to come up with its own answer, but the vocabulary and ideas presented in this talk can help find it.
I also embedded them below. If they're focussed, you can navigate with arrow keys or swipes (they're two-dimensional, with chapters on the horizontal axis and chapter content layed out vertically). Use Page Up/Down for linearized order and ? for more shortcuts.
Here's a good recording of the talk. I hope you'll like it.
I've been speaking at conferences for a few years now - prepare for a long list. 😉
Comment Your &*☠# Code!program entry, slides, videoat Accento
Südwerk, Henriette-Obermüller-Straße 10, Karlsruhe
Comment That Damn Code!announcement, slidesat Softwerkskammer Karlsruhe
Karlsruhe, diva-e Platforms GmbH, Ludwig-Erhard-Allee 20
Comment That Damn Code!program entry, slides, videoat JavaZone
Oslo Spektrum, Room 7