Стайлгайд - Victor-Y-Fadeev/qreal GitHub Wiki

Настройка Qt Creator

Включение табуляции в файлах кода:

• Открыть Инструменты -> Параметры
• Перейти во вкладку C++ и нажать Изменить
• Нажать Скопировать встроенный стиль
• Выбрать Только табуляцией в пункте Выполнять табуляцию

Включение в остальных файлах:

• Раздел Текстовый редактор
• Вкладка Поведение
• Выбрать пункты Только табуляцией и Отступами

Правила оформления Wiki

Основные принципы:

• Не создавайте лишние страницы
• Делите страницу на связные разделы
• Не пишите "сочинения", текст должен легко читаться
• Ссылки и перечисления приветствуются
• Ставьте точки

Поля

Названия переменных, пути к файлам, команды и другие относящиеся к коду или консоли вставки должны быть выделены полями (например, Some code).

Если вы указываете путь к файлу, он должен начинаться в корне репозитория, например ./qrealRobots.pro.

Команды для консоли должны отделяться полем на всю строку (каждая команда начинается с $), например:

$ Your command

Для создания поля, используйте обратные кавычки. Для списка команд поставьте 3 кавычки до и после.

Ссылки

Для создания ссылки используйте структуру [That you see](https://address.com), напрямую указывать ссылки запрещается!

Например, QReal.

Существующие ветки, файлы и пути к ним - должны обязательно сопровождаться ссылками и оформляться согласно предыдущим пунктам.