CodingStyle
Материал из Etersoft wiki
(перенаправлено с «Etersoft/CodingStyle»)
Перейти к навигацииПерейти к поиску
Требования к стилю разработки в Etersoft
Отдельные языки
Общий подход
- нельзя вписывать конструкции «на всякий случай», не понимая, что происходит
- нельзя оставлять «на потом» форматирование и комментарии (к сложным участкам кода)
Форматирование кода, стиль, стандарт
- код должен быть отформатирован
- код должен быть написан в стиле, принятом для соответствующего языка
- программа должна компилироваться без выдачи предупреждений
- программа должна состоять из модулей (логически завершённых блоков), разнесённых по файлам
Типы данных и память
- выделять память нужно с помощью принятых для этого в данном языке и среде функций, в едином стиле
- преобразования типов должны быть минимизированы и применяться по осознанной необходимости
- выделенную память надо освобождать
Пути к файлам
- программа не должна содержать прямых путей к файлам (переносимость!)
- для разделителя путей надо применять специальную константу
Совместная работа и релизы
- для каждой протестированной или выпускаемой сборки должен быть установлен tag в GIT
- запрещается копировать файлы с исходным кодом между разработчиками. Используйте GIT.
- для возможно большего числа функций в программе должны быть написаны тесты
- по каждому релизу должна быть сохранена бинарная сборка
