4 ms·
>That’s what I’m asking you! :) As I've been saying comments in the code should describe how that specific section of code works, and why it's done that way if
by tmh88j 6y ago
>That’s what I’m asking you! :)
As I've been saying comments in the code should describe how that specific section of code works, and why it's done that way if the "how" isn't enough. The new parts of the codebase would have comments describing how that code works. The unchanged code still functions as it always did. There's no reason to make comments on how another part of the codebase works. Code comments shouldn't be architectural descriptions of an entire codebase.
- nemetroid 6y agoThen perhaps we have different definitions of what "why" comments are. The usual reason we write code is to solve (business) problems, so to me, "why" implies a connection to business requirements. So even though > The unchanged code still functions as it always did. ...the why of that unchanged code, i.e. the reason it exists at all, may change. And for that reason, the "why" (the business reasons) should not be in the code.