Updated Clang Format Text Style (markdown) authored by williamfgc's avatar williamfgc
...@@ -9,6 +9,7 @@ ...@@ -9,6 +9,7 @@
2. <strong>Naming:</strong> Use meaningful English words, well-known acronyms (MPI, XML, CFD, GMRES, etc.), or well-known short names (Config, Comm, 2D, 3D). 2. <strong>Naming:</strong> Use meaningful English words, well-known acronyms (MPI, XML, CFD, GMRES, etc.), or well-known short names (Config, Comm, 2D, 3D).
* Examples: <strong>initialTime</strong> instead of <strong>tIni</strong> , or <strong>work</strong> instead of <strong>wrk</strong> </li> * Examples: <strong>initialTime</strong> instead of <strong>tIni</strong> , or <strong>work</strong> instead of <strong>wrk</strong> </li>
* One Exception: when redefining long types with the <strong>using</strong> keyword reasonable mnemonics and short names are allowed, always document scope. * One Exception: when redefining long types with the <strong>using</strong> keyword reasonable mnemonics and short names are allowed, always document scope.
```cpp ```cpp
...@@ -18,13 +19,13 @@ ...@@ -18,13 +19,13 @@
3. <strong>Avoid underscores:</strong> adds unnecessary length. Reserve it for prefixes of special cases (see class members and lambda functions). Use upper case letters instead. 3. <strong>Avoid underscores:</strong> adds unnecessary length. Reserve it for prefixes of special cases (see class members and lambda functions). Use upper case letters instead.
* Don't * _Don't_
```cpp ```cpp
std::vector<std::vector<<double>> this_is_my_very_very_long_two_dimensional_vector_name; std::vector<std::vector<<double>> this_is_my_very_very_long_two_dimensional_vector_name;
``` ```
* Do * _Do_
```cpp ```cpp
std::vector<std::vector<<double>> thisIsMyVeryVeryLongTwoDimensionalVectorName; std::vector<std::vector<<double>> thisIsMyVeryVeryLongTwoDimensionalVectorName;
... ...
......