4 ms·
>Also, it's a crime to spend 30 pages of 170 on how to write comments. I strongly disagree. Software engineering will be greatly improved, in my view, when com
by ternaryoperator 5y ago
>Also, it's a crime to spend 30 pages of 170 on how to write comments.
I strongly disagree. Software engineering will be greatly improved, in my view, when comments are viewed with the same rigor as code. In code reviews, we've finally gotten to the point where we don't generally approve code unless there are unit tests to accompany it. Codebases will be even stronger when PRs and code reviews require inclusion of updates to the corresponding comments and docs and are examined with the same care and attention.
Important problems disappear when comments are kept in sync with the code: 1) technical debt goes down, 2) it's much easier for new devs to get on board with the code base, 3) refactoring is facilitated.
The problem is that everyone has different ideas about comments should be. Many devs prefer a minimal approach, others a very talkative approach, etc. This book is the first to lay out a systematic approach to commenting with an explanation for the preferences the author espouses. Nobody else does this to my knowledge.
Those 35 pages are gold. And if all you take from the book is a deepened appreciation for comments and a systemic approach to commenting, I contend you will have greatly benefited.