|
|
1. <strong>Clang-format:</strong> ADIOS2 uses the clang-format tool to automatically enforce source code style and formatting rules. There are various ways to integrate the clang-format tool into your IDE / Code Editor depending on if you use Emacs, Vim, Eclipse, KDevelop, Microsoft Visual Studio, etc. that are a bit outside the scope of this document but a quick google search for "integrate clang-format" should point you in the right direction. Main points:
|
|
|
* Lines no longer than 80 characters.
|
|
|
* Always use braces { and }, even for 1 line <code>if</code> blocks.
|
|
|
* _Don't_
|
|
|
```
|
|
|
if( number != 1 )
|
|
|
number = 1;
|
|
|
```
|
|
|
* _Do_
|
|
|
```
|
|
|
if( number != 1 )
|
|
|
{
|
|
|
number = 1;
|
|
|
}
|
|
|
```
|
|
|
* Use 4 spaces for indentation.</li><li>However, you can always reformat the code manually by running:
|
|
|
```
|
|
|
clang-format -i SourceFile.cpp SourceFile.h
|
... | ... | |