StarMirror/CppCoreGuidelines
1
0
Fork 0
mirror of https://github.com/isocpp/CppCoreGuidelines.git synced 2024-03-22 13:30:58 +08:00
Code Issues Projects Releases Wiki Activity

[NL.{11,15}] Bring rules in order (#1629)

Browse Source 
The rules NL.11 (Make literals readable) and NL.15 (Use spaces
sparingly) are placed in inverted order in the text flow, swap them.
This commit is contained in:
rico-chet 2020-06-02 21:23:14 +02:00 committed by GitHub
parent 4625c984e9
commit 1936cb6b44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
CppCoreGuidelines.md
View File

@ -21298,6 +21298,38 @@ ISO Standard, but with upper case used for your own types and concepts:
Impossible.
### <a name="Rl-literals"></a>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 <chrono>
##### 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.
### <a name="Rl-space"></a>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.
### <a name="Rl-literals"></a>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 <chrono>
##### 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.
### <a name="Rl-order"></a>NL.16: Use a conventional class member declaration order
##### Reason