Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a couple more examples of acceptable commenting #323

Open
dotcode opened this issue Aug 29, 2019 · 1 comment
Open

Provide a couple more examples of acceptable commenting #323

dotcode opened this issue Aug 29, 2019 · 1 comment

Comments

@dotcode
Copy link
Contributor

dotcode commented Aug 29, 2019

After a discussion about reasonable use of comments, we thought it worth providing a couple of extra examples of where comments in code are useful (to complement the general rule that code should be self-documenting).

For example, from @morgaan "comment for tricks dictated by business needs"

@jpw
Copy link
Contributor

jpw commented Sep 2, 2019

I always liked "comments should be why, not what". If documenting what the code is doing, that's probably a code smell.

@josebolos josebolos removed their assignment Jun 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants