3 ms·
This seems a bit like a strawman argument. I don't think anybody say that we should never use comments. The problem with comments is that they can become stale
by yodsanklai 2y ago
This seems a bit like a strawman argument. I don't think anybody say that we should never use comments.
The problem with comments is that they can become stale, and it's often possible to self-document or write simpler code that causes less surprise. But of course, it's totally fine to put comments.
And I think comments should be mandatory for interfaces functions/types unless their behavior is obvious. I don't want to read the code to understand what a function does, or what invariant a class maintains. And if it's too complex to document in a few lines, probably this isn't the right interface. But apparently, this isn't obvious for everybody. In my company, most of the code isn't documented.