Оформление исходного кода

Приложения для ОС Аврора пишутся на C++ и QML с помощью фреймворка Qt. Для этих технологий есть рекомендации по созданию читаемого и поддерживаемого кода. Чёткий, лаконичный, читаемый, тестируемый и в целом высококачественный код является основным приоритетом, однако в каждой компании могут быть собственные корпоративные стандарты. Их стоит придерживаться, если это не вредит восприятию и читаемости кода. Статьи об оформлении исходного кода в данной документации описывают соглашения, принятые в ОМП. Разработчикам приложений для ОС Аврора рекомендуется придерживаться этих соглашений.

Правила оформления исходного кода на Qt/C++ и QML:

Также стоит обратить внимание на соглашения о коде и принципах разработки на Qt:

Соглашения о структуре проекта:

Название pro-файла совпадает с названием пакета, т.е. имеет вид: {доменное_имя}.{название_приложения}.
Стартовый cpp-файл приложения называется main.cpp.
Исходный код приложения на C++ находится в каталоге src, каталог src находится в корневом каталоге проекта.
QML-код находится в каталоге qml, каталог qml находится в корневом каталоге проекта.
В каталоге qml находится стартовый QML-файл, имя которого совпадает с названием приложения. Остальные QML-файлы размещены в подкаталогах.
Страницы приложения размещены в каталоге qml/pages.
Обложки приложения размещены в каталоге qml/cover.
Файлы переводов размещены в каталоге translations, каталог translations находится в корневом каталоге проекта.

Все эти соглашения соблюдаются в шаблонном приложении.