Added comments usage to style guide #4
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
||
| ```js | ||
| // Instantiate configuration | ||
| var config = { port: 3000 }; |
There was a problem hiding this comment.
If you look at the other examples in this guide, you'll notice that I don't use spaces after opening braces.
|
Thanks. Unfortunately your examples where sort of anti patterns for comments (adding no value to the code being commented on). So I did a patch myself: https://github.com/felixge/node-style-guide/blob/master/Readme.md#use-slashes-for-comments What do you think? |
|
Very well! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added comments section in style guide to solve #3:
Note: I didn't include a right and a wrong version since wrong is pretty hard to define when using comments. So I just included the best practice version.