618

4 out of 5 developers (files.techhub.social)

submitted 3 months ago* (last edited 3 months ago) by perishthethought@piefed.social to c/programmer_humor@programming.dev

13 comments fedilink hide all child comments

From: https://techhub.social/@FakeScrumStats/115246982974030476

you are viewing a single comment's thread
view the rest of the comments

[-] ChickenLadyLovesLife@lemmy.world 8 points 3 months ago

I went through this at my last job. I am a firm advocate of good comments in code, and my work was being reviewed by a guy 25 years younger than me who was a firm advocate of the idea that comments in code are not only undesirable but also an actual "code smell" - evidence of the professional incompetence of the developer that put them there.

I'm a school bus driver now.

[-] ChairmanMeow@programming.dev 9 points 3 months ago

What code is doing should generally (exceptions are always possible) be evident from the code itself, through clear naming, concise functions with singular goals and proper code structure.

Why code is doing what it does can be helpfully explained through a comment. X may update Y because of business decision Z, so putting a little bit of background info on Z can be very helpful for a future maintainer who might understand what X is doing but might not know why it's doing so in the first place.

If your code requires a lot of comments to make sense, the comments certainly can be a code smell.

[-] qaz@lemmy.world 3 points 3 months ago* (last edited 3 months ago)

Yesterday I got feedback on my PR asking me to add more XML comments. The userId parameter of type Guid parameter didn't have a param tag that said that it was the ID of the user. I was unable to convince them this was unnecessary and eventually conceded by adding a comment userId: ID of user.

[-] ChairmanMeow@programming.dev 3 points 3 months ago

See, that to me is an example of a useless comment. The only way I'd justify it is if you have some validation that checks if all public methods have xml comments or something. But userId: ID of user sounds redundant to me.

[-] ChickenLadyLovesLife@lemmy.world 2 points 3 months ago* (last edited 3 months ago)

I agree with what you say (and that is exactly what I meant by "good comments"), but that is not what this fellow's philosophy was. His philosophy was that all comments are bad no matter what, with no exceptions.