doc: introduce categories to Cpp style guide #17095
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
joyeecheung
reviewed
Nov 17, 2017
CPP_STYLE_GUIDE.md
Outdated
|
|
||
| Unfortunately, the C++ linter (based on | ||
| [Google’s `cpplint`](https://github.com/google/styleguide)), which can be run | ||
| explicitly via `make lint-cpp`, does not currently catch a lot of rules that are | ||
| specific to the Node.js C++ code base. This document explains the most common of | ||
| these rules: | ||
|
|
||
| # Formatting |
CPP_STYLE_GUIDE.md
Outdated
| * [Type casting](#type-casting) | ||
| * [Memory allocation](#memory-allocation) |
There was a problem hiding this comment.
Can you put "Others" as a top level item and put other rules under it?
CPP_STYLE_GUIDE.md
Outdated
| - `dynamic_cast` does not work because RTTI is not enabled | ||
| - Use `static_cast` for casting whenever it works | ||
| - `reinterpret_cast` is okay if `static_cast` is not appropriate | ||
| # Memory Management |
CPP_STYLE_GUIDE.md
Outdated
|
|
||
| Never use `std::auto_ptr`. Instead, use `std::unique_ptr`. | ||
|
|
||
| # Others |
fhinkel
force-pushed
the
nov/style-guide-reshuffle
branch
from
ae8a2e8
to
1c96975
Compare
fhinkel
force-pushed
the
nov/style-guide-reshuffle
branch
from
1c96975
to
afd79ef
Compare
cjihrig
approved these changes
Dec 3, 2017
|
Landed in fff4272 |
fhinkel
added a commit
to fhinkel/node
that referenced
this pull request
Dec 3, 2017
Ref: nodejs#17052 (comment) PR-URL: nodejs#17095 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 12, 2017
Ref: #17052 (comment) PR-URL: #17095 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 12, 2017
Ref: #17052 (comment) PR-URL: #17095 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Merged
gibfahn
pushed a commit
that referenced
this pull request
Dec 20, 2017
Ref: #17052 (comment) PR-URL: #17095 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Closed
gibfahn
pushed a commit
that referenced
this pull request
Dec 20, 2017
Ref: #17052 (comment) PR-URL: #17095 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Merged
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.
Introduce sections in the Cpp style guide as suggested by @joyeecheung in
#17052 (comment).
Checklist
Affected core subsystem(s)
doc