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

Properly Comment the Code #84

Closed
VincenzoFerme opened this issue Aug 20, 2016 · 0 comments
Closed

Properly Comment the Code #84

VincenzoFerme opened this issue Aug 20, 2016 · 0 comments
Assignees
Milestone

Comments

@VincenzoFerme
Copy link
Member

VincenzoFerme commented Aug 20, 2016

Comment all the choices in the code for which a comment might help to understand the why. Although it is tricky to decide what comment and what not to comment, a suggestion can be to comment all the code that after a couple of day you wrote need more than 5 seconds to grasp what the code is doing. For sure algorithms must be commented and documented in the most important steps.

See also #13

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants