Update C++ style guide #941
Merged
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
lilleyse
commented
Aug 27, 2024
|
|
||
| We believe that source code should be readable and even beautiful, but that automated formatting is more important than either concern. Especially when readability is largely a matter of what we're used to, and beauty is mostly subjective. For our JavaScript / TypeScript code, we format our code with the ubiquitous [Prettier](https://prettier.io/) tool. In C++, clang-format is widely used but there's no de facto style, and so we've created a clang-format style that tracks as close to Prettier as possible. We will be able to get closer once this [clang-format patch](https://reviews.llvm.org/D33029) is merged. |
There was a problem hiding this comment.
We will be able to get closer once this clang-format patch is merged.
This will handled in a separate PR to use AlignAfterOpenBracket=BlockIndent
Comment on lines
+149
to
+156
| ## 🗂️ Other | ||
|
|
||
| Not covered by C++ Core Guidelines. | ||
|
|
||
| * Use `this->` when accessing member variables and functions. This helps distinguish member variables from local variables and member functions from anonymous namespace functions. | ||
| * Static function definitions in a .cpp file should be preceded by `/*static*/`. | ||
| * Unused parameter names in callbacks should be commented out rather than omitted. Only use `[[maybe_unused]]` when you can't comment out parameter names, such as when parameters are conditionally accessed by `constexpr` logic. | ||
| * Use `[i]` instead of `.at(i)` for sequence containers like `std::vector` and `std::array`. |
There was a problem hiding this comment.
I considered splitting these into separate sections, but it felt like too many extra headings. What do others think?
|
This all looks good to me! Anyone else want to review before we merge it? |
|
Seems like a "no"! 😄 |
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.
Preview: https://github.com/CesiumGS/cesium-native/blob/update-style-guide/doc/style-guide.md
Updated the C++ style guide based on internal discussion. For the most part, this is just documenting conventions that already exist in cesium-native.