diff --git a/docs/en/contribute/style-guide.rst b/docs/en/contribute/style-guide.rst index 296345c091..0c8262e726 100644 --- a/docs/en/contribute/style-guide.rst +++ b/docs/en/contribute/style-guide.rst @@ -323,7 +323,7 @@ C++ Header files have the extension ``.hpp``. C++ source files have the extensio Naming ^^^^^^ -* **Class and struct** names shall be written in ``CamelCase`` with a capital letter as beginning. Member variables and methods shall be in ``snake_case``. +* **Class and struct** names shall be written in ``CamelCase`` with a capital letter as beginning. Member variables and methods shall be in ``snake_case``. An exception from ``CamelCase`` is if the readability is severely decreased, e.g. in ``GPIOOutput``, then an underscore ``_`` is allowed to make it more readable: ``GPIO_Output``. * **Namespaces** shall be in lower ``snake_case``. * **Templates** are specified in the line above the function declaration. * Interfaces in terms of Object-Oriented Programming shall be named without the suffix ``...Interface``. Later, this makes it easier to extract interfaces from normal classes and vice versa without making a breaking change.