hubbub icon indicating copy to clipboard operation
hubbub copied to clipboard

Comment consistency

Open afeld opened this issue 12 years ago • 3 comments

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 avatar Jan 29 '13 10:01 afeld

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

afeld avatar Jan 29 '13 10:01 afeld

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

afeld avatar Jan 29 '13 11:01 afeld

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).

caseywebdev avatar Jan 29 '13 15:01 caseywebdev