Updated Clang Format Text Style (markdown) authored by williamfgc's avatar williamfgc
......@@ -17,4 +17,10 @@ using std::vector<std::vector<double>> = vDouble2D;
<li><strong>Avoid underscores:</strong> adds unnecessary length to the variable name, especially when combined with STL container types, and could conflict with name mangling. Reserve it for prefix of special cases (see class members and lambda functions). Use upper case letters instead.<ul><li><code>Don't</code><pre style="border: 0;"><code> std::vector &lt; std::vector &lt; &lt; double &gt; &gt; <strong>this_is_my_very_very_long_two_dimensional_vector_name;</strong> </code></pre></li><li><code>Do</code> <pre style="border: 0;"><code> std::vector &lt; std::vector &lt; &lt; double &gt; &gt; <strong>thisIsMyVeryVeryLongTwoDimensionalVectorName;</strong> </code></pre></li></ul></li><li>
<strong>Using and typedef:</strong> Prefer the keyword using over typedef 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 . <ul><li><code>Don't</code> <ul><li><pre style="border: 0;"><code> typedef std::vector &lt; std::vector &lt; std::map &lt; std::string , double &gt; &gt; &gt; <strong>MapIn2DVector;</strong> </code></pre></li></ul></li><li><code>Do</code> <ul><li><pre style="border: 0;"><code> using std::vector &lt; std::vector &lt; std::map &lt; std::string , double &gt; &gt; &gt; = <strong>MapIn2DVector;</strong> </code></pre></li></ul></li></ul></li></ol>
\ No newline at end of file
<strong>Using and typedef keywords:</strong> Prefer the keyword using over typedef 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 .
<ul>
<li>Don't:
```cpp typedef std::vector<std::vector<std::map<std::string, double>>> MapIn2DVector;```
</li>
<li><code>Do</code> <ul><li><pre style="border: 0;"><code> using std::vector &lt; std::vector &lt; std::map &lt; std::string , double &gt; &gt; &gt; = <strong>MapIn2DVector;</strong> </code></pre></li></ul></li></ul></li></ol>
\ No newline at end of file