Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
29 lines (23 loc) · 1004 Bytes

comment-your-code.md

File metadata and controls

29 lines (23 loc) · 1004 Bytes
title tags date slug description searchKeywords featuredImage slides videoSlug
Comment Your &*☠# Code!
agile
clean-comments
documentation
2016-06-24
talk-comment-your-code
A heartfelt rant / thoughtful talk arguing for more comments in code
comments
comment-your-code
comment-your-code-accento-2019

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.