diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 28031f201..534cf476a 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -211,6 +211,67 @@ a += "b" + "d"; ``` +* Initializers + +We allow brace enclosed initializers only for aggregates and arrays/containers.
+Brace enclosed initializer MUST be used with equality sign if it follows the variable declaration.
+Brace enclosed initializer MUST be additionally enclosed in parentheses if it is used in constructor initialization list.
+Some valid use cases: +```c++ +// aggregate +Person john = { "John", "Smith", 21 }; +Person *john = new Person { "John", "Smith", 21 }; + +// array +int array[] = { 1, 2, 3, 4 }; + +// container +QHash map = { + { "key1", "value1" }, + { "key2", "value2" } +); + +// member array +SomeClass::SomeClass(BaseClass *parent) + : BaseClass(parent) + , m_someArrayMember({ 1, 2, 3, 4 }) +{ +} + +// return from function +Person getPersonByName(const QString &name) +{ + // do something + return { name, surname, age }; +} + +// function argument +doSomething({ name, surname, age }, someOtherArg); +``` + +* **auto** keyword + +We allow the use of the **auto** keyword only where it doesn't break the readability of the code (i.e. either we can gather enough information about the type from the right part of the expression, or we do not need to know the exact type), or where it is strictly necessary (for example, to compute the type of a lambda, etc.).
+Some valid use cases: +```c++ +template +void doSomethingWithList(const List &list) +{ + foreach (const auto &item, list) { + // we don't know item type here so we use 'auto' keyword + // do something with item + } +} + +for (auto it = container.begin(), end = container.end(); it != end; ++it) { + // we don't need to know the exact iterator type, + // because all iterators have the same interface +} + +auto spinBox = static_cast(sender()); +// we know the variable type based on the right-hand expression +``` + * Space around operations eg `a = b + c` or `a=b+c`: Before and after the assignment there should be a space. One exception could be: for loops. @@ -225,5 +286,5 @@ for (int a=0; a