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

Comment consistency #48

Open
afeld opened this issue Jan 29, 2013 · 3 comments
Open

Comment consistency #48

afeld opened this issue Jan 29, 2013 · 3 comments
Labels

Comments

@afeld
Copy link
Contributor

afeld commented Jan 29, 2013

I tend towards brevity/laziness in my inline comments and often use lowercase phrases - seems others use proper capitalized sentences. We should make this consistent throughout the repo. I'm fine either way. Votes?

@afeld
Copy link
Contributor Author

afeld commented Jan 29, 2013

Also, I usually rely on word wrapping rather than doing line breaks at 80 chars - this is inconsistent as well.

@afeld
Copy link
Contributor Author

afeld commented Jan 29, 2013

Same with single vs. double-quotes for String literals.

@caseywebdev
Copy link
Contributor

Obviously this is all personal preference, but I tend to use full sentences in comments (for automatic documentation generators like docco/docker), break at 80 chars (helps for viewing files in GitHub where there's no line wrap), and single quote (no concrete reason for this =p).

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

No branches or pull requests

2 participants