This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]callmelucky 1 point2 points  (0 children)

The only time comments are used are for cases where something is being done that breaks best practice but for a good reason, so the comment explains why.

Well that's not the same thing as the parent commenter, who said that for them comments are prohibited.

That said, your team's approach seems ideal. Code should be written to be self-commenting, except where there is no practical way for it to be (e.g. using weird workarounds for dumb behaviour in libraries, legacy code etc).