Skip to content

Changes

Page history
Updated File Header Structure and Includes (markdown) authored by williamfgc's avatar williamfgc
Show whitespace changes
Inline Side-by-side
File-Header-Structure-and-Includes.md
View page @ 6548da89
......@@ -17,16 +17,16 @@
//End of file
#endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_
</code></pre></li></ul></li></ol></li><li>
</code></pre></li></ul></li></ol></li>
<strong>Documenting included headers:</strong> list header components used in the code if header is not self-explanatory<ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code>//vector and map are self-explanatory, no comment needed
<li><strong>Documenting included headers:</strong> list header components used in the code if header is not self-explanatory<ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code>//vector and map are self-explanatory, no comment needed
#include &lt;vector&gt;
#include &lt;utility&gt; //std::pair
#include &lt;stdexcept&gt; //std::invalid_argument
#include &lt;map&gt;
</code></pre></li></ul></li></ol></li></ol>
<strong>Header include organization:</strong> Use the following ordering for the included headers: Example for file ClassName.cpp :<ol><li>Corresponding header: ClassName.h </li><li>System C/POSIX Headers <em>e.g.</em> unistd.h, sys/ipc.h</li><li>C++ versions of system C headers <em>e.g.</em> cstdlib, cstring</li><li>System C++ headers <em>e.g.</em> vector, map</li><li>Other library headers <em>e.g.</em> boost, zfp, bzip2, thrust</li><li>Other headers from this library <em>e.g</em> &quot;adiosFunctions.h&quot;</li></ol><ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code> #include &quot;ClassName.h&quot;
<li><strong>Header include organization:</strong> Use the following ordering for the included headers: Example for file ClassName.cpp :<ol><li>Corresponding header: ClassName.h </li><li>System C/POSIX Headers <em>e.g.</em> unistd.h, sys/ipc.h</li><li>C++ versions of system C headers <em>e.g.</em> cstdlib, cstring</li><li>System C++ headers <em>e.g.</em> vector, map</li><li>Other library headers <em>e.g.</em> boost, zfp, bzip2, thrust</li><li>Other headers from this library <em>e.g</em> &quot;adiosFunctions.h&quot;</li></ol><ul><li>Example:</li></ul><ol><li><ul><li><pre style="border: 0;"><code> #include &quot;ClassName.h&quot;
</code></pre></li><li><pre style="border: 0;"><code> #include &lt;unistd.h&gt; // write, close
#include &lt;sys/ipc.h&gt; // key_t
</code></pre></li><li><pre style="border: 0;"><code> #include &lt;vector&gt;
......