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 @ 3fe18ae7
......@@ -10,13 +10,13 @@
*/
</code></pre></li></ul></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, **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>
<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, **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>
//File contents...
...
//End of file
#endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_
#endif // end of ADIOS2_ENGINE_BP_BPFILEWRITER_H_
</code></pre></li></ul></li></ol></li>
<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
......