Skip to content

Changes

Page history
Updated File Header Structure and Includes (markdown) authored by williamfgc's avatar williamfgc
Hide whitespace changes
Inline Side-by-side
File-Header-Structure-and-Includes.md
View page @ 8ae5d528
......@@ -8,19 +8,23 @@
* Author: John Doe john.doe@email.com
*/
</code></pre></li></ul></li><li><strong>Header include organization:</strong> 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
</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;
</code></pre></li><li><pre style="border: 0;"><code> #include &lt;vector&gt;
#include &lt;new&gt; // std::bad_alloc
</code></pre></li><li><pre style="border: 0;"><code>#include &lt;bzip2.h&gt;
</code></pre></li><li><pre style="border: 0;"><code> #include &lt;bzip2.h&gt;
#include &lt;zfp.h&gt;
</code></pre></li><li><pre style="border: 0;"><code>#include &quot;adiosFunctions.h&quot; // IsLittleEndian
</code></pre></li></ul></li></ol></li><li><strong>Include guards:</strong> all headers must have include guards to prevents name conflict. These are place right after the license and at the end of the file. The adopted format includes the relative path in ADIOS. For example, file adios2/engine/bp/BPFileWriter.h will contain the following include guards:<ol><li><ul><li><pre style="border: 0;"><code>
</code></pre></li><li><pre style="border: 0;"><code> #include &quot;adiosFunctions.h&quot; // IsLittleEndian
</code></pre></li></ul></li></ol></li><li>
<strong>Include guards:</strong> all headers must have include guards to prevents name conflict. These are place right after the license and at the end of the file. The adopted format includes the relative path in ADIOS. For example, file adios2/engine/bp/BPFileWriter.h will contain the following include guards:<ol><li><ul><li><pre style="border: 0;"><code>
#ifndef ADIOS2_ENGINE_BP_BPFILEWRITER_H_
#define ADIOS2_ENGINE_BP_BPFILEWRITER_H_<br><br>
...
#endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_ at the end of file
</code></pre></li></ul></li></ol></li><li><strong>Include Documentation:</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> #include &lt;vector&gt; //self-explanatory
</code></pre></li></ul></li></ol></li><li>
<strong>Document includes:</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> #include &lt;vector&gt; //self-explanatory, not needed
#include &lt;utility&gt; //std::pair
#include &lt;stdexcept&gt; //std::invalid_argument
</code></pre></li></ul></li></ol></li></ol>
\ No newline at end of file