search

backstopmedia / hubbub

Sample project for the book Developing a Backbone.js Edge
http://backstopmedia.github.com/hubbub/
21 stars 111 forks source link

Comment consistency #48

Open afeld opened 11 years ago

afeld commented 11 years ago

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 commented 11 years ago

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

afeld commented 11 years ago

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

caseywebdev commented 11 years ago

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