bf63aca389
* Minor comment fix * Minor language fix * Minor language fix * Minor clarification * Minor language fix * Minor language fix * Remove whitespace for clarity * Make whitespace consistent (again, it wasn't the "bad" here, right?) * Minor language fix * Change weird formatting for emphasis * Fix (what I believe is) a slightly distracting typo * Minor language fix * Suggest to highlight even security vulnerabilities as a possible outcome of concurrency errors * Minor language fix * Suggest to add new section for a seemingly unrelated note * Minor language fix * Minor language fix (not sure what this intended to say in the first place?) * Minor language fix * Add minor remark * Minor language improvement * Minor language fix * Point out a bad example * Minor fixes * Minor language fix * Add missing period (the lack of which doesn't look bad here, but does a bit in the rendered html) * Minor language fix * Minor language fix * Minor typo fix (but is this what was meant?) * Minor language improvement (?) * Minor language fix * Minor language fix (?) * Add missing closing quotation mark * Minor language fix * Minor language fix * Remove extra dot (or was it supposed to be three dots instead?) * Minor language fix * Minor language fix * Minor language fix * Minor language fix * Minor language improvement * Minor formatting improvements * Minor improvements * Minor language fix * More fixing * Add missing parentheses (did I get it right?) * Minor language fix (?) * Minor language fix * Minor language fix * Fix language (but is this what was meant in the first place?) * Update heading to match content (in particular, the example) * Remove superfluous whitespace * Update also the "bad" example to use int* |
||
|---|---|---|
| .github/workflows | ||
| docs | ||
| scripts | ||
| talks | ||
| .gitignore | ||
| .travis.yml | ||
| CONTRIBUTING.md | ||
| cpp_core_guidelines_logo_text.png | ||
| CppCoreGuidelines.md | ||
| dump.cpp | ||
| LICENSE | ||
| param-passing-advanced.png | ||
| param-passing-normal.png | ||
| README.md | ||
"Within C++ is a smaller, simpler, safer language struggling to get out." -- Bjarne Stroustrup
The C++ Core Guidelines are a collaborative effort led by Bjarne Stroustrup, much like the C++ language itself. They are the result of many person-years of discussion and design across a number of organizations. Their design encourages general applicability and broad adoption but they can be freely copied and modified to meet your organization's needs.
Getting started
The guidelines themselves are found at CppCoreGuidelines. The document is in GH-flavored MarkDown. It is intentionally kept simple, mostly in ASCII, to allow automatic post-processing such as language translation and reformatting. The editors maintain one version formatted for browsing. Note that it is manually integrated and can be slightly older than the version in the master branch.
The Guidelines are a constantly evolving document without a strict "release" cadence. Bjarne Stroustrup periodically reviews the document and increments the version number in the introduction. Checkins that increment the version number are tagged in git.
Many of the guidelines make use of the header-only Guidelines Support Library. One implementation is available at GSL: Guidelines Support Library.
Background and scope
The aim of the guidelines is to help people to use modern C++ effectively. By "modern C++" we mean C++11, C++14, and C++17. In other words, what would you like your code to look like in 5 years' time, given that you can start now? In 10 years' time?
The guidelines are focused on relatively higher-level issues, such as interfaces, resource management, memory management, and concurrency. Such rules affect application architecture and library design. Following the rules will lead to code that is statically type-safe, has no resource leaks, and catches many more programming logic errors than is common in code today. And it will run fast -- you can afford to do things right.
We are less concerned with low-level issues, such as naming conventions and indentation style. However, no topic that can help a programmer is out of bounds.
Our initial set of rules emphasizes safety (of various forms) and simplicity. They may very well be too strict. We expect to have to introduce more exceptions to better accommodate real-world needs. We also need more rules.
You will find some of the rules contrary to your expectations or even contrary to your experience. If we haven't suggested that you change your coding style in any way, we have failed! Please try to verify or disprove rules! In particular, we'd really like to have some of our rules backed up with measurements or better examples.
You will find some of the rules obvious or even trivial. Please remember that one purpose of a guideline is to help someone who is less experienced or coming from a different background or language to get up to speed.
The rules are designed to be supported by an analysis tool. Violations of rules will be flagged with references (or links) to the relevant rule. We do not expect you to memorize all the rules before trying to write code.
The rules are meant for gradual introduction into a code base. We plan to build tools for that and hope others will too.
Contributions and LICENSE
Comments and suggestions for improvements are most welcome. We plan to modify and extend this document as our understanding improves and the language and the set of available libraries improve. More details are found at CONTRIBUTING and LICENSE.
Thanks to DigitalOcean for hosting the Standard C++ Foundation website.