Шаблоны

Чтобы код оставался читаемым, несмотря на синтаксический шум, у нас есть несколько дополнительных правил форматирования кода метапрограммирования:

• операторы using name = ... всегда располагайте сразу после =, если они не помещаются в одну строку;
• учитывайте семантику функции метапрограммирования. Например, std::conditional — это конструкция «если-то-иначе». Следовательно, разместите условие if на отдельной строке и сделайте то же самое для двух случаев;
• используйте один уровень отступа для каждого «открытого» шаблона и размещайте закрывающий >, >::type или >::value на отдельной строке. Например:

using optional_result_type =
    typename std::conditional<
        std::is_same<result_type, void>::value,
        bool,
        optional<result_type>
    >::type;
// думайте об этом как о следующем (недействительном C++):
auto optional_result_type =
    conditional {
        if result_type == void
        then bool
        else optional<result_type>
    };

Обратите внимание, что это не обязательно при простом определении псевдонима типа. При работе с «обычными» шаблонами допустимо делать отступ на основе позиции открывающего <, например:

using response_handle_type = response_handle<Subtype, message, ResponseHandleTag>;

Макросы препроцессора

• Используйте макросы только тогда, когда вы не можете получить тот же результат, используя встроенные функции или правильные константы.
• Имена макросов имеют форму RIOT__.

Комментарии

• Комментарии Doxygen начинаются с ///.
• Вместо средств форматирования Doxygen используйте Markdown.
• Используйте @cmd вместо \cmd.
• Для определения основных комментариев, которые не должны быть проглочены Doxygen, используйте //.