View source for Help:Manual of style

==Code formatting==

====Capitalization====
Names are capitalized in the same way as in most of the C++ standard. The documentation of the standard components should follow the following style:
* function parameters use {{tt|small_caps}} style
* template parameters use {{tt|CamelCase}} style

In examples and other documentation, the following additional guidelines apply:
* custom class names use {{tt|CamelCase}} style
* variable names use {{tt|small_caps}} style
* macro and constant names use {{tt|ALL_CAPS}} style

====Spacing and indentation====
* K&R indentation style is used (see [[enwiki:Indent_style#Variant:_1TBS_(OTBS)|K&R TBS]]).
* Standard constructs, i.e. {{tt|for}}, {{tt|while}}, {{tt|if}}, etc have a space between identifier and opening parentheses, e.g. <br/>{{tt|for (...)}}.
* There is no space between function name and the parentheses, as well as between the parentheses and the content between them, e.g. {{tt|fun(...)}}.
* There is no space between template name and {{tt|<}} symbol, as well as between {{tt|<}} and {{tt|>}} symbols and the template parameters, e.g. {{tt|tmp<...>}}.
* Multiple function or template parameters are separated by space ''after'' the comma.
* There is no space between reference and pointer ({{tt|&}} and {{tt|*}}) modifiers and the type name (e.g. int& b).
* If the parameters of a function span several lines, the indentation of all parameters matches the opening parenthesis. The same goes for template parameters.

For example:

{{source|lang=cpp|1=
#include <vector>

std::vector<int, MyAllocator> v;

int complex_function(int long_param_name,
                     int& another_param_name);

int main(int argc, char* argv[])
{
    if (argc == 2)
    {
        std::cout << argv[0] << '\n';
        std::cout << argv[1] << '\n';
    }
    else
        std::cout << argv[0] << '\n';
}

}}

Not all of these rules apply for the detailed feature declarations (those going into {{tt|<nowiki>{{dcl ***}}</nowiki>}} template), since extra readability is needed. The exceptions include:
* There is space between the {{tt|<}} and {{tt|>}} symbols and template parameters for function templates.
* Class templates have their parameters laid out through several lines.
* For function parameters, that are templates, there are no spaces between the {{tt|<}} and {{tt|>}} symbols and the template parameters. Also, there is no space after the comma separating the template parameters.

For example:

{{dcl begin}}
{{dcl | 1=
template <
    class TemplateParam,
    class TemplateParam2
> class TemplateClass;
}}
{{dcl | 1=
template< class TemplateParam, class TemplateParam2 >
int function_template( MyTemplate<T,Param> my_template_param,
                       int* other_param );
}}
{{dcl end}}

{{todo|<br>
We need to develop a recommended {{tt|.clang_format}} file for
# header synopses
# page synopses
# the examples
}}