Наследование свойств в проектах Visual Studio

Собственная система проектов Visual Studio основана на MSBuild. Платформа MSBuild определяет форматы файлов и правила сборки проектов любого типа. Она в значительной степени упрощает сборку для нескольких платформ и конфигураций. Вам будет полезно разобраться в ее работе. Это особенно важно, если потребуется определять пользовательские конфигурации или создавать многоразовые наборы свойств, которые можно совместно использовать и импортировать в несколько проектов.

Файл VCXPROJ, файлы PROPS и TARGETS

Свойства проекта хранятся в нескольких файлах. Некоторые из них находятся непосредственно в файле проекта .vcxproj. Другие свойства определяются в файлах .targets или .props, которые импортируются файлом проекта и содержат значения по умолчанию. Файлы проекта Visual Studio находятся в папке, соответствующей языковому стандарту, в базовом каталоге %VSINSTALLDIR%\MSBuild\Microsoft\VC\<version>. Значение атрибута <version> зависит от версии Visual Studio. v160 соответствует версии Visual Studio 2019.

Свойства также хранятся в любых пользовательских файлах .props, которые вы можете добавить в свой проект. Мы настоятельно рекомендуем НЕ ИЗМЕНЯТЬ эти файлы вручную. Если у вас нет четкого представления о работе MSBuild и строении файлов .vcxproj, используйте для изменения свойств, особенно участвующих в наследовании, страницы свойств в интегрированной среде разработки.

Как указано выше, одному свойству для некоторой конфигурации можно назначить разные значения в разных файлах. При сборке проекта модуль MSBuild оценивает файл проекта и все импортированные файлы в строго определенном порядке, который описывается ниже. По мере оценки каждого файла все значения свойств, определенные в этом файле, переопределяют существующие значения. Все неуказанные значения наследуются от файлов, оцененных ранее. При установке свойства с помощью страниц свойств важно также следить за тем, где именно вы это делаете. Если задать свойство X в файле .props, при том что для того же свойства задано значение Y в файле проекта, проект будет создан со свойством, имеющим значение Y. Если то же свойство имеет значение Z для элемента проекта, например файла .cpp, то модуль MSBuild использует значение Z.

Ниже представлено базовое дерево наследования.

1. Параметры по умолчанию из набора инструментов MSBuild CPP (файл Microsoft.Cpp.Default.props в базовом каталоге, который импортируется файлом .vcxproj)

2. Страницы свойств.

3. Файл .vcxproj. (Этот файл может переопределять параметры по умолчанию и параметры страницы свойств.)

4. Метаданные элементов.

Совет

Свойство, выделенное полужирным шрифтом на странице свойств, определяется в текущем контексте. Свойство в обычном шрифте наследуется.

Просмотр развернутого файла проекта со всеми импортированными значениями

Иногда полезно просмотреть развернутый файл, чтобы определить, как наследуется значение данного свойства. Для просмотра развернутой версии введите следующую команду в командной строке Visual Studio (замените заполнители на конкретные имена файлов).

msbuild /pp:temp.txtmyapp.vcxproj

Развернутые файлы проекта могут быть большими и трудными для понимания, если вы не знакомы с MSBuild. Ниже представлена основная структура файла проекта.

1. Основные свойства проекта, которые не представлены в интегрированной среде разработки.

2. Импорт файла Microsoft.cpp.default.props, который определяет некоторые базовые, независимые от набора инструментов свойства.

3. Глобальные свойства конфигурации (предоставляемые как свойства по умолчанию PlatformToolset и Project на странице Конфигурация > Общие). Эти свойства определяют, какие страницы свойств набора инструментов и встроенные страницы свойств будут импортироваться в Microsoft.cpp.props на следующем шаге.

4. Импорт файла Microsoft.cpp.props, который задает большинство значений проекта по умолчанию.

5. Импорт всех страниц свойств, включая файлы .user. Эти страницы свойств могут переопределить все значения, кроме свойств по умолчанию PlatformToolset и Project.

6. Остальная часть свойств конфигурации проекта. Эти значения могут переопределять значения, заданные на страницах свойств.

7. Элементы (файлы) вместе с связанными с ними метаданными. Эти элементы всегда используются последними в правилах вычисления MSBuild, даже если находятся до других свойств и импортов.

Дополнительные сведения см. в разделе Свойства MSBuild.

Конфигурации сборки

Конфигурация — это просто произвольная группа свойств, которым назначено имя. Visual Studio предоставляет конфигурации отладки и выпуска. Каждая из них задает различные свойства соответственно для сборки отладки или выпуска. Вы можете использовать Configuration Manager для определения настраиваемых конфигураций. Так удобно группировать свойства для определенной конфигурации сборки.

Чтобы лучше разобраться в конфигурациях сборки, откройте диспетчер свойств. Его можно открыть, выбрав View > Property Manager или View > Other Windows > Property Manager в зависимости от параметров. В диспетчере свойств есть узлы для каждой пары конфигурации и платформы в проекте. В каждом из этих узлов находятся узлы для страниц свойств (файлы .props), позволяющие задать некоторые свойства для этой конфигурации.

Например, можно перейти в область "Общие" на страницах свойств. Измените значение свойства "Кодировка" на "Не задано" вместо "Использовать Юникод" и нажмите кнопку ОК. В диспетчере свойств страницы свойств Поддержка Юникода больше не будет. Она удаляется для текущей конфигурации, но сохраняется для других.

Дополнительные сведения о диспетчере и страницах свойств см. в статье Совместное или повторное использование параметров проекта Visual Studio C++.

Совет

Файл .user является нерекомендуемым. Мы рекомендуем удалить его, чтобы обеспечить правильную группировку свойств по конфигурации и платформе.