Updated Clang Format Text Style (markdown) authored by williamfgc's avatar williamfgc
......@@ -17,20 +17,19 @@ using std::vector<std::vector<double>> = vDouble2D;
</ul>
<li><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.
<ul>
<li> Don't
```cpp
std::vector<std::vector<<double>> this_is_my_very_very_long_two_dimensional_vector_name;
```
</li>
<li> Do
```cpp
std::vector<std::vector<<double>> thisIsMyVeryVeryLongTwoDimensionalVectorName;
```
</li>
</ul>
** Don't
```cpp
std::vector<std::vector<<double>> this_is_my_very_very_long_two_dimensional_vector_name;
```
** Do
```cpp
std::vector<std::vector<<double>> thisIsMyVeryVeryLongTwoDimensionalVectorName;
```
</li>
<li><strong>Using and typedef keywords:</strong> Prefer the keyword <strong>using</strong> over <strong>typedef</strong> for readability. Only rename very long complex or custom types, do not rename standard types ( int , double , std::vector ). Prefer including ADIOSTypes.h as it contains fixed types in the std:: namespace uint8_t, uint64_t .
......
......