Re:Writing system software: code comments
by ridiculous_fish on Sunday October 07, 2018 @09:56PM
(#18163636)
A lot of disagreement and talking past each other in this thread.
One unacknowledged facet: Code with different purposes requires different levels of commenting. If you're (say) implementing a UI, you can often avoid commenting through good naming: `saveDocumentButtonClicked()`. But if you are implementing the C++11 spec, you should provide liberal references to that spec in the comments.
Comments become more important as the code becomes more forced and less natural.
One unacknowledged facet: Code with different purposes requires different levels of commenting. If you're (say) implementing a UI, you can often avoid commenting through good naming: `saveDocumentButtonClicked()`. But if you are implementing the C++11 spec, you should provide liberal references to that spec in the comments.
Comments become more important as the code becomes more forced and less natural.