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.
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.
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.
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.