© Giuliana Carullo 2020
G. CarulloImplementing Effective Code Reviewshttps://doi.org/10.1007/978-1-4842-6162-0_8

8. Comments

Giuliana Carullo1 
(1)
Dublin, Ireland
 

I listen to their story, they listen to my comments, and then I pocket my fee.

—Sherlock Holmes in Sir Arthur Conan Doyle’s “A Study in Scarlet” (1887)

I know you probably mumbled several times while coding because you have been asked to write or to update comments. You might think, is it not enough to have some sort of comments inside my code? They must be coherent as well? Mumble, mumble. The answer is yes, they have to. Think about it as doing a favor for your future self. Months from now, you may need to revisit the code you wrote today. It might be crystal clear to you right now, but ...

Get Implementing Effective Code Reviews: How to Build and Maintain Clean Code now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.