Description of the coding style used in StreamFlow
StreamFlow uses the same coding style as MeteoIO (see description here), with the following additions:
- The name of a private class attribute (whether static or not) should always start with an underscore. This allows for simple visual discrimination between private attributes and local variables. Public attributes should not start with an underscore. For example,
_my_private_attributeis a valid name for a private attribute, but
my_public_attributeis not (although it is a valid name for a public attribute).
- The name of a static attribute should contain only 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,
GRAVIT_ACCELERATIONis a valid name for a public static attribute, and
_MAX_NUM_ITERATIONSis a valid name for a private static attribute.
- 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,
_my_attributeis a valid attribute name, but