Commit 8e6fe747 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

Fix typos, point to Dune's style guide.

parent 42f8a940
# Style guide
This style guide is taken, modified and enhanced from [DUNE](https://dune-project.org/dev/codingstyle/).
## General formatting
* Use 4 spaces indent (no tabs, not 2 spaces)
* _Trailing whitespace_: source files may not contain trailing whitespace to reduce the amount of noise in diffs and during merges.
* In contrast to the remainder of the coding style guidelines, these code formatting rules are (partially) enforced automatically with a pre-commit hook. Due to the distributed nature of git, this hook can only check your commits once they arrive in the central repository, so it is important to make your local git repository check your commits as well. The dunecontrol script will automatically install such a pre-commit hook for you.
* Use 4 spaces indent (no tabs, not 2 spaces).
* _Trailing whitespace_: source files may not contain trailing whitespace to reduce
the amount of noise in diffs and during merges.
* In contrast to the remainder of the coding style guidelines, these code formatting
rules are (partially) enforced automatically with a pre-commit hook. Due to the
distributed nature of Git, this hook can only check your commits once they arrive
in the central repository, so it is important to make your local Git repository check
your commits as well. The dunecontrol script will automatically install such a pre-commit
hook for you.
## C++
......@@ -19,7 +27,7 @@
//! \todo Please doc me!
```
* We use doxygen to generate documentation from the source code
* We use Doxygen to generate documentation from the source code
```c++
int lineOfCode = 1; // Short comment on line of code 1 that will _not_ show in doxygen
......@@ -34,7 +42,7 @@
int lineOfCode = 4;
```
* Files always contain the following documentation header before the headerguard
* Files always contain the following documentation header before the headerguard:
```c++
/*!
......@@ -48,7 +56,7 @@
where `GroupName` is a doxygen module group, click [here](https://git.iws.uni-stuttgart.de/dumux-repositories/dumux/blob/master/doc/doxygen/modules.txt) for an overview of existing groups.
* Each class should be documented using the following style
* Each class should be documented using the following style:
```c++
/*!
......@@ -64,7 +72,7 @@
class MyClass {};
```
* Each free function and class member function should be documented using the following style
* Each free function and class member function should be documented using the following style:
```c++
/*!
......@@ -85,44 +93,44 @@
}
```
* Also document non-obvious function parameters at call site
* Also document non-obvious function parameters at call site:
```c++
localResidual.eval(/*includeBoundaries=*/true);
```
* Possible exceptions thrown by a function
* Possible exceptions thrown by a function.
### Naming schemes
* avoid abbreviation, i.e. `saturation` instead of `s`
* Avoid abbreviation, i.e. write `saturation` instead of `s`.
#### Variables / Functions
* CamelCase starting with a lower case letter, each new word starting with a capital letter
* no underscores (except private data members, see below)
* exception: If and only if a single letter that represents an
* CamelCase starting with a lower case letter, each new word starting with a capital letter.
* No underscores (except private data members, see below).
* Exception: If and only if a single letter that represents an
abbreviation or index is followed by a single letter (abbreviation or index),
CamelCase is __not__ used.
* examples
- `pw` but `pressureW`, because "pressure" is a word
- `srnw` but `sReg`, because "Reg" is not an abbreviation of a single letter
- `pcgw` but `dTauDPi`, because "Tau" and "Pi" are words and longer than a letter
- `CaCO3`, because we write chemical formulas in their chemically sensible way
* Examples:
- `pw` but `pressureW`, because "pressure" is a word.
- `srnw` but `sReg`, because "Reg" is not an abbreviation consisting of a single letter.
- `pcgw` but `dTauDPi`, because "Tau" and "Pi" are words and longer than one letter.
- `CaCO3`, because we write chemical formulas in their chemically sensible way.
* private data members end with an underscore
* Private data members end with an underscore.
#### Typenames / Classes / Aliases / Namespaces
* same rules as for variables, except the first letter is capital
* Same rules as for variables, except the first letter is capital.
#### Filenames / Folders
* lower case letters (filenames, but not foldernames may contain underscores)
* Header files get the suffix `.hh`, implementation files the suffix `.cc`
* Every header file contains a unique header guard. The name should mimic the folder structure, and contain the filename,
* Lower case letters (filenames, but not foldernames may contain underscores).
* Header files get the suffix `.hh`, implementation files the suffix `.cc`.
* Every header file contains a unique header guard. The name should mimic the folder structure and contain the filename,
i.e. for a file `common/myfile.hh` it should be
```c++
......@@ -136,13 +144,13 @@
### Indent
* The default indent is 4 spaces (no tabs, not 2 spaces)
* The default indent is 4 spaces (no tabs, not 2 spaces).
### Formatting
* Curly brackets that open or close a scope are on a separate line (except for [namespaces](#Namespaces))
* There should be a space between `if`,`else if`,`switch` and the condition
* `if`,`else if`,`switch` can omit brackets if the expression is only one line
* Curly brackets that open or close a scope are on a separate line (except for [namespaces](#Namespaces)).
* There should be a space between `if`,`else if`,`switch` and the condition.
* `if`,`else if`,`switch` can omit brackets if the expression is only one line.
```c++
// comment for if block, space between if and (enableGravity)
......@@ -159,9 +167,9 @@
### Namespaces
* Open curly brackets on the same line
* Do not indent the code inside the namespace
* Comment closing curly brackets uniquely
* Open curly brackets on the same line.
* Do not indent the code inside the namespace.
* Comment closing curly brackets uniquely.
```c++
namespace Dumux {
......@@ -174,14 +182,14 @@
} // end namespace Dumux
```
* Use a `Detail` namespace for hiding implementation details, e.g. for template meta programming
* Use a `Detail` namespace for hiding implementation details, e.g. for template meta programming.
### Includes
* Space between `#include` and path
* C++ standard library includes first, then Dune, then others, then DuMu<sup>x</sup>
* Always use project relative paths
- exception: the other header is in the same folder and closely related (`#include "volumevariables.hh"`)
* Space between `#include` and path.
* C++ standard library includes first, then Dune, then others, then DuMu<sup>x</sup>.
* Always use project relative paths.
- Exception: the other header is in the same folder and closely related (`#include "volumevariables.hh"`).
```c++
#include <type_traits>
......@@ -191,22 +199,22 @@
### Property system
* Prefer class templates with regular template arguments over class templates with a `TypeTag` as template argument
* Prefer class templates with regular template arguments over class templates with a `TypeTag` as template argument.
### Exception
* The use of exceptions for error handling is encouraged
* There is a variety of DuMux and Dune-specific exceptions you can throw
* The use of exceptions for error handling is encouraged.
* There is a variety of DuMu<sup>x</sup> and Dune-specific exceptions you can throw.
* All derive (possibly indirectly) from the class `Dune::Exception` in dune-common.
## Files and folders
* Try to order your new header into the existing directory structure
* Headers are named like the classes they contain (usually one class per file, exception: closely tied helper classes / functions)
* Headers are named lower case only (using underscores only if absolutely necessary for readability)
* Folder names are lower case only
* Try to order your new header into the existing directory structure.
* Headers are named like the classes they contain (usually one class per file, exception: closely tied helper classes / functions).
* Headers are named lower case only (using underscores only if absolutely necessary for readability).
* Folder names are lower case only.
* Tests should be called after model and discretization scheme using underscores and lower case only, e.g.
```
......@@ -216,7 +224,7 @@
## CMake
* Use named arguments only
* Use named arguments only.
* TODO
## Python
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment