|
|
StreamFlow uses the same [coding style as MeteoIO](https://meteoio.slf.ch/CodingStyle/), with the following additions:
|
|
|
<ul>
|
|
|
<li>The name of a private class attribute (whether static or not) should <i>always</i> start with an underscore. This allows for simple visual discrimination between private attributes and local variables. Public attributes should <i>not</i> start with an underscore. For example, <code>_my_private_attribute</code> is a valid name for a private attribute, but <code>my_public_attribute</code> is not (although it is a valid name for a public attribute).</li>
|
|
|
<li>The name of a <em>static</em> attribute should contain <i>only</i> upper case letters (and underscores). Non-static attributes should be written in lower case. This allows for simple visual discrimination between static and non-static attributes. For example, <code>GRAVIT_ACCELERATION</code> is a valid name for a public static attribute, and <code>_MAX_NUM_ITERATIONS</code> is a valid name for a private static attribute.</li>
|
|
|
<li>If the name of a class attribute is composed of several words, those should be separated by underscores. Camel case is reserved for function arguments or function names. For example, <code>_my_attribute</code> is a valid attribute name, but <code>_myAttribute</code> is not.</li>
|
|
|
</ul> |
|
|
\ No newline at end of file |