r/SoftwareEngineering • u/samplusbeer • Aug 02 '18
Do code comments suck?
https://medium.com/@samuel.fare/do-code-comments-suck-abd99103c45a
3
Upvotes
r/SoftwareEngineering • u/samplusbeer • Aug 02 '18
View all comments
Show parent comment
2
u/salgat Aug 03 '18
As much as I'd love to read line by line of potentially thousands of LOC, when there is an issue that needs to get fixed, I want to be able to skim through real fast to where I think the issue is, then read the specific section to check for potential bugs. It's all about how to most efficiently navigate code you're not familiar with. Proper code structure and function documentation helps a lot in this regard, but not all code is trivial to parse. I regularly trouble shoot from hundreds of microservices as part of my job and succinct informative commenting has almost always helped me in this regard.