diff --git a/CppCoreGuidelines.md b/CppCoreGuidelines.md index 5534976..455d5d7 100644 --- a/CppCoreGuidelines.md +++ b/CppCoreGuidelines.md @@ -21298,6 +21298,38 @@ ISO Standard, but with upper case used for your own types and concepts: Impossible. +### NL.11: Make literals readable + +##### Reason + +Readability. + +##### Example + +Use digit separators to avoid long strings of digits + + auto c = 299'792'458; // m/s2 + auto q2 = 0b0000'1111'0000'0000; + auto ss_number = 123'456'7890; + +##### Example + +Use literal suffixes where clarification is needed + + auto hello = "Hello!"s; // a std::string + auto world = "world"; // a C-style string + auto interval = 100ms; // using + +##### Note + +Literals should not be sprinkled all over the code as ["magic constants"](#Res-magic), +but it is still a good idea to make them readable where they are defined. +It is easy to make a typo in a long string of integers. + +##### Enforcement + +Flag long digit sequences. The trouble is to define "long"; maybe 7. + ### NL.15: Use spaces sparingly ##### Reason @@ -21333,38 +21365,6 @@ This rule was added after many requests for guidance. We value well-placed whitespace as a significant help for readability. Just don't overdo it. -### NL.11: Make literals readable - -##### Reason - -Readability. - -##### Example - -Use digit separators to avoid long strings of digits - - auto c = 299'792'458; // m/s2 - auto q2 = 0b0000'1111'0000'0000; - auto ss_number = 123'456'7890; - -##### Example - -Use literal suffixes where clarification is needed - - auto hello = "Hello!"s; // a std::string - auto world = "world"; // a C-style string - auto interval = 100ms; // using - -##### Note - -Literals should not be sprinkled all over the code as ["magic constants"](#Res-magic), -but it is still a good idea to make them readable where they are defined. -It is easy to make a typo in a long string of integers. - -##### Enforcement - -Flag long digit sequences. The trouble is to define "long"; maybe 7. - ### NL.16: Use a conventional class member declaration order ##### Reason