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

Comments in code #120

Open
rub1e opened this issue Jan 20, 2019 · 0 comments
Open

Comments in code #120

rub1e opened this issue Jan 20, 2019 · 0 comments
Assignees
Labels
Priority-2 rubie Words of wisdom from Rubie

Comments

@rub1e
Copy link

rub1e commented Jan 20, 2019

Not sure I've seen a single comment yet!

This might seem unimaginable to you, while in the fire of a fast turnaround project, but there will be parts of your code that you've written with your own two hands that you'll come back to in a month and will be utterly unintelligible to you.

So much so that you'll swear you never wrote it - or that someone's changed it without telling you

The truth is that you just forget what things do, or why you did them in such-and-such a way, and so on.

Using comments (in conjunction with sensible function names) is a good way of ensuring you always know what everything does - not to mention being very helpful for people reading your code 😉

@zurda zurda added rubie Words of wisdom from Rubie Priority-2 labels Jan 21, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority-2 rubie Words of wisdom from Rubie
Projects
None yet
Development

No branches or pull requests

3 participants