imtoken网站|csproj文件 _比特派(Bitpie)官网-比特派钱包app官方下载-bitpie官网下载app

理解C#项目构建配置文件——MSBuild csproj文件 - 知乎

理解C#项目构建配置文件——MSBuild csproj文件 - 知乎首发于FreewheelLee的编程艺术切换模式写文章登录/注册理解C#项目构建配置文件——MSBuild csproj文件FreewheelLeeMicrosoft 全栈工程师内容概要什么是 csproj 文件和MSBuildcsproj 文件的主要构成元素C#项目构建过程（ csproj 文件的解析过程）小结和提示（MSBuild 涉及的内容非常多，同时官方文档也很齐全，本文不会一一细聊。本文的目的在于简要地描述整个MSBuild csproj 解析和执行的大概轮廓，指出一些关键点，方便读者进一步深入学习。）什么是 MSBuild和csproj 文件（MSBuild - MSBuild）The Microsoft Build Engine is a platform for building applications. This engine, which is also known as MSBuild, provides an XML schema for a project file that controls how the build platform processes and builds software. 简单的说 MSBuild 是一个构建应用程序的平台和工具，本文特指构建 C# 应用程序。MSBuild 使用 XML 格式的配置文件控制如何构建应用程序。MSBuild 跟 Visual Studio 是什么关系？Visual Studio uses MSBuild, but MSBuild doesn't depend on Visual Studio. By invoking msbuild.exe on your project or solution file, you can orchestrate and build products in environments where Visual Studio isn't installed.Visual Studio uses MSBuild to load and build managed projects. The project files in Visual Studio (.csproj, .vbproj, .vcxproj, and others) contain MSBuild XML code that executes when you build a project by using the IDE. Visual Studio projects import all the necessary settings and build processes to do typical development work, but you can extend or modify them from within Visual Studio or by using an XML editor.即 MSBuild 是一个独立的工具，Visual Studio 使用 MSBuid 加载和构建项目。当 Visual Studio 新建一个 C# 项目时，会在project folder（而不是 solution folder）下新建一个 csproj 文件，MSBuild 通过解析这个文件就知道如何构建当前的程序。看个简单的 csproj 文件例子 —— 一个非常简单的 XML 文件

Exe

net6.0

enable

这就是用 Visual Studio 新建的 Console Application project 的 csproj 文件，是不是非常简洁？甚至完全看不出这样一个简短的文件如何让 MSBuild 知道怎么构建这个项目。揭晓这个答案之前，先熟悉一下 csproj 文件的主要构成元素之后文章的内容都会使用 https://github.com/freewheel70/MSBuildSample 作为例子，读者可以自行 clone 下来操作。csproj 文件的主要构成元素为避免歧义，所有元素名我都保留了英文（如 Project元素）而斜体英文名不是元素名而是指代一类元素的种类名称如（如 Property 元素)Project 元素这是根元素，其中最重要的属性（元数据）之一就是上面看到的 Sdk ，稍后详解PropertyGroup 元素和 Property 元素（MSBuild Properties - MSBuild）顾名思义PropertyGroup 元素是一个 group 元素，子元素是一些 property 元素。而 property 元素是简单的键值对，即元素名为键，元素内容为值（元素名字不是 Property）。例如，上面那个例子里的 PropertyGroup 里包含了OutputType, TargetFramework, ImplicitUsing 等 Property我们也可以自定义，比如新增一个 PropertyGroup

FreeLee

9876543

换句话说，你可以理解为 property 就是一些自定义变量。在构建的过程中可以利用这些变量值，比如作为判断语句的条件值，作为某个任务的输入，等等。重复定义了Property 会发生什么？如果后面的 Property 名字跟之前的相同，那么后面的值会覆盖前面的值。例如：

FreeLee

9876543

... ...

FreeLee2

那么在实际运行时， MyName 的值是 FreeLee2ItemGroup元素和Item元素（MSBuild Items - MSBuild）顾名思义ItemGroup元素是一个 group 元素，子元素是一些 Item 元素Item 元素：在 MSBuild 中，Item 是对一个或多个文件的引用, 包含元数据（如文件名、路径和版本号）一些常见的 Item 元素以及它们支持的元数据可以参考 Common MSBuild Project Items - MSBuild 和更详细的内容参考https://github.com/dotnet/msbuild/blob/main/src/MSBuild/MSBuild/Microsoft.Build.CommonTypes.xsd 示例：

支持通配符Item 元素的元数据中最重要的就是 Include，指向了文件的路径，其他常见通用的元数据参考 MSBuild Well-known Item Metadata - MSBuild ，此外，不同的 Item 元素有不同的元数据定义，可以查阅上面的两个链接，例如

这段 xml 的意思是：希望MSBuild每次构建总是将 mydata.json 复制到构建输出的文件夹里。效果如下图注意：Item 元素本身并不会要求MSBuild做任何操作，它只是非常纯粹的文件引用，CopyToOutputDirectory也只是一个元数据而不是动作。真正引导 MSBuild 构建的是后面马上会讲解的 Task。重复定义了Item 会发生什么？不同于 Property，重复的 Item 不会相互覆盖，而是变成一个列表比如

那么引用 Compile Item 时，就会获得一个包含了 file2.cs 和 file1.cs 的列表。 Target 元素和 Task 元素（MSBuild Targets - MSBuild ，MSBuild Tasks - MSBuild）Target和Task MSBuild构建过程中最核心最重要的元素。Target 是一系列任务的组合（所以理解为 TaskGroup 也没毛病），Task 则是具体的任务 —— 比如，复制文件，输出信息，编译源码，构建引用的其他项目。Target 最重要的属性是AfterTargets, BeforeTargets 和 DependsOnTargets ，看名字就知道它们都是关于执行顺序的。Task 元素种类很多，最简单的就是 Message ，它做的事情就是在 console 上输出一段信息，比如 hello world 示例：

上面这个自定义名为 MyTarget 的 Target 会在 CoreCompile 后执行，执行时输出三段文本上面的 $(OS) $(PROCESSOR_ARCHITECTURE) 引用了环境变量，我们也可以使用 $(MyName) 来引用我们上面自定义的 Property更多常用的Task可以参考 MSBuild Task Reference - MSBuild 例如重复定义了Target会发生什么？跟 property 类似，重复定义的 Target 会覆盖之前的定义，例如

... ...

实际运行输出的是 Hello World 介绍完主要的元素后，开始正式理解 MSBuild project file 的解析和执行过程。正如文章开头的那个例子，一个非常简单的MSBuild Project file 里明明没有定义任何的 Target 和 task，为什么却能让 MSBuild 成功构建这个项目呢？答案就是 Project 元素的 Sdk 属性MSBuild 根据 Sdk 属性的值，会隐式地导入一些常见的 Properties 和 Targets 然后生成一个新的完整的详细的 MSBuild Project file （可以这么理解，虽然并不会真的生成一个文件）具体的生成逻辑是先导入sdk定义的常见的 properties再复制 MSBuild project file 的主体内容最后导入sdk定义的常见的 targets对这个顺序的理解很重要，因为如果在 MSBuild project file 定义的 property 与sdk定义的常见的 property 重名，我们定义的值会成功覆盖默认值。如果在 MSBuild project file 定义的 targets与sdk定义的常见的 targets重名，我们定义的targets会被覆盖而不生效。这些常见的 Properties 和 Targets 的内容可以查看 sdk/src/Tasks/Microsoft.NET.Build.Tasks/sdk at main · dotnet/sdk 或者在本地文件夹 C:\Program Files\dotnet\sdk\6.0.202\Sdks\Microsoft.NET.Sdk\Sdk\ 下（根据安装的 sdk 版本不同可能路径不同）其中的导入逻辑相对复杂，这边不做展开。我们可以使用MSBuild CLI的一个参数 preprocess 生成完整的 MSBuild project file 方便我们理解，例如在我的示范项目下运行（运行报错的读者可以看看文章结尾的小提示）msbuild -preprocess:.\MSBuildSample\Complete.csproj .\MSBuildSample\MSBuildSample.csproj就会得到一个Complete.csproj文件，打开这个文件，可以看到一些有意思的东西。首先是这个文件特别大，16000+行，但是其中有大量的注释，这些注释对理解这个生成过程非常有帮助，例如清晰地指出从什么地方导入了这些内容。通过搜索也可以验证上面说的3个步骤的顺序 —— 如，我们编写的MSBuild Project file 的内容被放在了中间。扩展点在 Complete.csproj 中搜索 AfterCompile注释中清楚地写着，如果你想在 Compile 结束后做点什么，可以重新定义 AfterCompile 这个target。即 AfterCompile 可以看作一个扩展点。怎么做呢? 在 MSBuildSample.csproj 里重新定义吗？读者可以试试，会发现不起作用。原因就是上面提到的2个点：1. MSBuildSample.csproj 的内容在最终的 Complete.csproj 中处于中间，而上面截图中的代码处于后面 2. 重复定义的 Target 会由后面覆盖前面，因此在 MSBuildSample.csproj 里定义 AfterCompile target 会被覆盖正确的方式之一是新建一个 Directory.Build.targets 文件，然后在里面重新定义 AfterCompile target参考 https://github.com/freewheel70/MSBuildSample/blob/main/MSBuildSample/Directory.Build.targets 为什么是 Directory.Build.targets 呢？因为 Directory.Build.targets 文件会在较后面才导入 —— 读者可以在 Complete.csproj 里验证。除了 AfterCompile，读者可以在 Complete.csproj 里查找其他的扩展点target。小结Project, PropertyGroup, Property, ItemGroup, Item, Target, Task 是 MSBuild Project file 中最重要最常见的元素Project 的 sdk 属性会让 MSBuild 隐式地导入一些常见的 properties 和 targets通过新建一个 Directory.Build.targets 文件，定义所需要的 target 或者重新定义扩展点 target 可以引导 MSBuild 构建，执行我们需要的任务小提示msbuild 指令需要在 visual studio 的 terminal 下运行，在外部的 terminal 会报错 visual studio 里可以调整 MSBuild 输出日志的详细程度，方便学习进阶主题有兴趣进阶学习的读者可以考虑下面几个主题使用 Visual Studio 和 MSBuild.exe 构建有什么区别Item definitions —— 怎么自定义 Item Task 的输入和输出UsingTask 元素 —— 怎么自定义 TaskTargets 执行顺序（Target Build Order - MSBuild） Parallel execution —— 并行执行其他参考链接（或有趣的相关链接）：How MSBuild builds projects - MSBuild MSBuild Tasks - MSBuild MSBuild Command-Line Reference - MSBuild https://github.com/dotnet/msbuild/tree/main/src/Tasks How can I get MSBuild to copy all files marked as Content to a folder, preserving folder structure? sdk/src/Tasks/Microsoft.NET.Build.Tasks/targets at main · dotnet/sdk https://github.com/dotnet/msbuild/blob/main/src/MSBuild/MSBuild/Microsoft.Build.CommonTypes.xsd 编辑于 2022-05-08 18:14C#msbuild.NET赞同 391 条评论分享喜欢收藏申请转载文章被以下专栏收录FreewheelLee的编程艺术微软全栈工程师，不定期分享各类技术和

.csproj 文件_csproj是什么文件-CSDN博客

.csproj 文件

最新推荐文章于 2023-07-21 21:10:44 发布

RayRings

最新推荐文章于 2023-07-21 21:10:44 发布

阅读量1.5w

点赞数

分类专栏：

文章标签：

本文链接：https://blog.csdn.net/m0_37805255/article/details/100104202

版权

专栏收录该内容

6 篇文章

0 订阅

订阅专栏

.csproj 文件

.csproj，是C#项目文件的扩展名，它是“C Sharp Project”的缩写。.net开发环境中建立项目时，会产生.csproj文件，这是C#的工程文件，其中记录了与工程有关的相关信息，例如包含的文件，程序的版本，所生成的文件的类型和位置信息等。

【作用】

.csproj究竟是做什么用的？它是给开发工具用的，例如我们再熟悉不过的Visual Studio，以及大家可能没有接触过的MSBuild.exe。

Visual Studio会根据csproj里的XML定义来管理项目文件以及相关其他一些种类非常丰富的数据及操作，MSBuild也会根据csproj文件来得知编译这个项目需要有哪些依赖，默认输出路径，Pre-Build和Post-Build需要哪些操作等。

Visual Studio和MSBuild都是开发工具，这就是csproj存在的唯一意义：为“开发工具”提供信息。而到了运行环境中，根本不会有人关心所谓的csproj文件——也就是“程序是从哪里来的”。

【各个部件的作用】

PropertyGroup

PropertyGrouph是用来存放属性的地方，这与它的名字非常契合。

在这里写属性就像在代码中定义属性或变量一样，只要写了，就会生成一个指定名称的属性。

比如，我们写：

watermelon is a fruit

那么，就会生成一个 Foo 属性，值为字符串 watermelon is a fruit。至于这个属性有什么用，那就不归这里管了。

PropertyGroup可以定义很多个，里面都可以同等地放属性。至于为什么会定义多个，原因无外乎有两个：

增加可读性 —— 将一组相关的属性放在一起，便于阅读和理解意图；便于加条件 —— 有的属性在 Debug 和 Release 下不一样（例如条件编译符 DefineConstants）。

ItemGroup

ItemGroup是用来指定集合的地方。

集合里面一些常见的项：

Reference：引用某个程序集PackageReference：引用某个NuGet包ProjectReference：引用某个项目Compile：常规的 C# 编译None：执行一些通用的操作（或者只是为了在 Visual Studio 列表中能够有一个显示）Folder：一个空的文件夹

ItemGroup 也可以放很多组，同样是为了提升可读性或者增加条件。

Import

Import是为了导入属性（props）和Targets（后面会具体说Targets）。

被我们 Import 进来的那些文件，可以用两种扩展名表示，一种是用来定义属性，为 .props；另一种用来定义行为，为 .targets。这两种文件除了含义不同以外，内容的格式都是完全一样的 —— 即 csproj 文件格式。

虽然 csproj 文件中可以完全实现引入的 props 文件的功能，但为了在多个项目中使用，一处更新，到处生效，因此选择单独用 props 文件来存放。

Target

一般来说， Target 节点写在 csproj 文件的末尾，但这个并不是强制的。Targets 是一种非常强大的功能扩展方式，支持 msbuild 预定义的一些指令，支持命令行，甚至支持使用 C# 直接编写（当然编译成 dll 会更方便些），还支持这些的排列组合和顺序安排。而我们实质上的编译过程便全部由这些 Targets 来完成。甚至可以说，编译过程就是靠这些 Target 的组合来完成的。

Project

所有的 csproj 文件都是以 Project 节点为根节点。

下面列出新旧两款 csproj 文件格式的差异：

其中，在各部件中，白色代表必须，灰色代表可选；而更接近背景色的灰色代表一般情况下都是不需要的。

可以看出，新格式的最大好处之一就是简洁。而这一优势，靠的就是 Project 节点，新格式中的 Project 节点有 sdk 属性 —— 所谓 sdk，其实是一大波 .targets 文件的集合。它帮我们导入了公共的属性、公共的编译任务，还帮我们自动将项目文件夹下所有的 **\*.cs 文件都作为 ItemGroup 的项引入进来。

【 .sln 和 .csproj 的区别】

1. .sln：即 solution，解决方案

.csproj：即 C sharp project，C# 项目

2. 解决方案是项目的集合，项目是文件的集合；一个 sln 中可以包含多个 csproj。一个 csproj 可以包含多个文件； csproj 可以作为单独的项目运行，也可以在 sln 中添加 csproj 统一管理。

3. sln 和 csproj 都可以双击运行，如果解决方案中只有一个项目，那么两个方式是没有区别的；但是如果一个解决方案中包含多个项目， sln 会加载该解决方案中所有的项目，而 csproj 只会加载当前项目。

4. 关于 sln 和 csproj 的几个问题

（1）C#、.net 中，.sln 文件可以删掉重新生成吗？

.sln 是项目文件，删除后项目的一些设置会无法恢复，因为解决方案里面可能有关于这个项目文件的很多信息，所以一般不建议删除重建；但一般也没有太大的问题，用VS直接打开 .csproj 工程文件，会自动建上 sln 的。

（2）下载的 ASP.net 源码没有.sln 或 .csproj 文件如何使用？

从 Visual Studio IDE 的菜单 "文件" --> "打开" --> "网站" ，然后从右边的目录中选择要打开的网站目录，不需要有 .sln 文件就可以打开网站并调试运行。如果是 WebSite 模式那么是不需要 .sln 文件的，可以通过 File -> WebSite -> OpenWebSite 打开。如果不是 WebSite 模式，那么可以自己建立一个空项目，然后把文件 Copy 进去即可。

参考链接：https://blog.csdn.net/han_better/article/details/64140875

优惠劵

RayRings

关注

踩

觉得还不错?

一键收藏

知道了

.csproj 文件

.csproj 文件.csproj，是C#项目文件的扩展名，它是“C Sharp Project”的缩写。.net开发环境中建立项目时，会产生.csproj文件，这是C#的工程文件，其中记录了与工程有关的相关信息，例如包含的文件，程序的版本，所生成的文件的类型和位置信息等。【作用】.csproj究竟是做什么用的？它是给开发工具用的，例如我们再熟悉不过的Visual Studio，以...

复制链接

扫一扫

专栏目录

API_TEST.csproj.uesr

10-26

C#2416GPIO的项目文件，想要看的可借鉴借鉴

csproj 文件、sln文件的简单介绍。

weixin_30740581的博客

01-15

522

1.csproj文件：

.net 开发环境中建立项目时，会产生 .csproj 文件，这是C#的工程文件，其中记录了与工程有关的相关信息，例如包含的文件，程序的版本，所生成的文件的类型和位置的信息等。Visual Studio会根据csproj里的XML定义来管理项目文件以及相关其他一些种类非常丰富的数据及操作。为“开发环境”提供信息。到了运行环境中，iis根本不会关心所谓的csproj文件。 ...

1 条评论

您还未登录，请先

后发表或查看评论

无聊的CSPROJ 文件,很无聊

dennydaniel的专栏

05-28

1387

http://schemas.microsoft.com/developer/msbuild/2003"> Debug AnyCPU 8.0.50727 2.0 {A626B36B-DA06-4DB5-8C00-BB7A52CB2AD8} WinExe Properties ReadCardv1 ReadCardv1 true

ProjectSync:这个基本的控制台应用程序使您的 *.csproj 文件与文件系统更改保持同步，使其在不专门使用 Visual Studio 进行开发的团队中工作时非常有用

07-01

项目同步

这个基本的控制台应用程序使您的 csproj 文件与文件系统更改保持同步，这在不专门使用 Visual Studio 进行开发的团队中工作时非常有用。

它目前支持单个命令行参数——要观察的工作目录。

它支持大量配置选项，所有选项都有“合理”的默认值，可以在 program.cs 的顶部看到

git提交数据教程

11-01

团队开发常用的git工具教程，这里提供的是上传文件教程的其中之一。

IDE(6)——VS系列(6)——csproj工程文件

qq_34573534的博客

06-10

1697

csproj工程文件

这里面，csproj是我们最常见的核心文件，CSharp Project，它是用于构建这个项目的工程文件。

csproj是基于xml格式的MSBuild项目文件，其仍然是文本文件，可以打开并修改定义了的工程构造的属性，比如选择性的添加或删除或修改包含在项目中的文件或引用、修改项目版本、将其转换为其它类型项目等。

MSBuild是微软定义的一个用于生成应用程序的平台(Mi...

理解 C# 项目 csproj 文件格式的本质和编译流程

oper1000的博客

01-27

927

写了这么多个 C# 项目，是否对项目文件 csproj 有一些了解呢？Visual Studio 是怎么让 csproj 中的内容正确显示出来的呢？更深入的，我能够自己扩展 csproj 的功能吗？

本文将直接从 csproj 文件格式的本质来看以上这些问题。

csproj文件常用设置及C#注释常用写法

博客

06-29

774

csproj文件常用设置及C#注释常用写法

(转)Visual Studio中.sln文件和.csproj文件的区别

逝不等琴生的博客

03-11

1807

介绍

sln:solusion 解决方案

csproj:c sharp project C#项目

区别

1.解决方案是项目的集合,项目是文件的集合；一个sln中可以包含多个csproj。一个csproj可以包含多个文件；csproj可以作为单独的项目运行，也可以在sln中添加csproj统一管理。

2.sln和csproj都可以双击运行，如果解决方案中只有一个项目那么两个方式是没有区别的...

【CSharp】关于xxx.csproj文件的理解

jn10010537的博客

07-21

592

Visual Studio会根据csproj里的内容来定义来管理项目文件以及相关其他一些种类非常丰富的数据及操作。.csproj文件记录了与工程有关的相关信息，例如包含的文件，程序的版本，所生成的文件的类型和位置信息等。在.NET框架的开发环境中建立项目时，会产生.csproj文件，这是C#的项目工程文件。csproj的全称是C Sharp Project的缩写，是C#项目文件的扩展名。上面的iRayBase.csproj 文件后缀是 .csproj。在示例代码里，遇到.csproj 文件。

vscode-csproj:Visual Studio Code扩展，使您的csproj文件保持最新

05-16

VS Code .csproj扩展

此扩展名将帮助您在使用VS Code时使csproj文件保持同步。如果您在同时使用VS Code和Visual Studio的团队中工作，这将很有用。

演示版

将文件添加到项目

从项目中删除文件

单个文件删除

多文件删除

这个怎么运作

当您切换到文件系统树或不在文件系统树中最近的.csproj保存文件时，系统将提示您。

选择“关闭”将在状态栏中添加一个项目，并且在您打开文件时不再询问您。

文件不在csproj中

csproj中包含的文件

您可以通过命令面板将文件添加到csproj：

或通过文件资源管理器中的上下文菜单：

扩展设置

此扩展程序提供以下设置：

设定键

描述

csproj.enable

启用/禁用此扩展名。

csproj.itemType

从文件扩展名到csproj XML元素的映射。默认为： { "*": "Content

VS.net VSS时，编译报错：未能向文件“.csproj.FileListAbsolute.txt”写入命令行对路径的访问被拒绝。

09-06

在VSS上把项目的Bin和Obj目录删除，然后重新取出项目，编译成功。

无法读取项目文件 .csproj,请确认 Import 声明中的路径正确

07-09

无法读取项目文件 .csproj,请确认 Import 声明中的路径正确.doc

csproj-check:检查.csproj文件，以确保它们不引用丢失的文件

05-03

csproj检查检查Visual Studio csproj文件中的错误。可用作git pre-commit钩子。安装npm i -g csproj-check 用法csproj-check # defaults to **/*csproj-check a/specific/project.csproj another/project.csproj...

Make2CSProjUpdater:从源文件列表更新.csproj ItemGroupCompile元素

05-20

作为项目的作者，有大量的Mono .csproj文件与Makefile源列表不。 Makefile源列表是已知的良好来源，因为它们用于构建Mono，而在该容量中不使用项目文件。但是，在Mono编译器（mcs.exe）和PlayScript编译器（playc....

c# Thread、ThreadPool、Task有什么区别，什么时候用，以及Task的使用

m0_37805255的博客

09-04

3838

c# Thread、ThreadPool、Task有什么区别，什么时候用，以及Task的使用

这三者都是为了处理耗时任务，且都是异步的。

Thread

Thread就是Thread，需要自己调度，适合长跑型的操作。

ThreadPoll

ThreadPool是Thread基础上的一个线程池，目的是减少频繁创建线程的开销。线程很贵，要开新的stack，要增加CPU上下文切换，所以Threa...

NuGet 是什么? 理解与使用

m0_37805255的博客

08-29

3605

NuGet 是什么? 理解与使用

NuGet 是一个自由开源软件包管理系统，用于Microsoft开发平台，以前称NuPack。

NuGet 作为 Visual Studio 扩展，能够简化在 Visual Studio 项目中添加、更新和删除库（部署为程序包）的操作。NuGet 包是打包成单个ZIP文件，文件扩展名是 .nupkg，使用开放打包约定（OPC）格式，包好编译代码（Dll）、与...

事件监听机制——Java vs. C#

m0_37805255的博客

09-02

469

事件监听机制——Java vs. C#

C#语言类似Java，但两者之间的差别还是显而易见的，比如下面要说到的——事件监听机制。

Java的事件监听机制

Java中的事件监听是整个Java消息传递的基础和关键。其中涉及三类对象：事件源（Event Source）、事件（Event）、事件监听器（Event Listener）。

事件源：事件发生的场所，通常就是各个组件，比如一个按钮，或...

.csproj文件怎么打开

理解 C# 项目 csproj 文件格式的本质和编译流程 - walterlv - 博客园

会员

周边

新闻

博问

AI培训

云市场

所有博客

当前博客

我的博客

我的园子

账号设置

简洁模式 ...

退出登录

walterlv

博客园

首页

新随笔

联系

管理

理解 C# 项目 csproj 文件格式的本质和编译流程

本文将直接从 csproj 文件格式的本质来看以上这些问题。

阅读本文，你将：

可以通读 csproj 文件，并说出其中每一行的含义

可以手工修改 csproj 文件，以实现你希望达到的高级功能（更高级的，可以开始写个工具自动完成这样的工作了）

理解新旧 csproj 文件的差异，不至于写工具解析和修改 csproj 文件的时候出现不兼容的错误

csproj 里面是什么？

总览 csproj 文件

相信你一定见过传统的 csproj 文件格式。就算你几乎从来没主动去看过里面的内容，在版本管理工具中解冲突时也在里面修改过内容。

不管你是新手还是老手，一定都会觉得这么长这么复杂的文件一定不是给人类阅读的。你说的是对的！传统 csproj 文件中有大量的重复或者相似内容，只为 msbuild 和 Visual Studio 能够识别整个项目的属性和结构，以便正确编译项目。

不过，既然这篇文章的目标是理解 csproj 文件格式的本质，那我当然不会把这么复杂的文件内容直接给你去阅读。

我已经将整个文件结构进行了极度简化，然后用思维导图进行了分割。总结成了下图，如果先不关注文件的细节，是不是更容易看懂了呢？

如果你此前也阅读过我的其他博客，会发现我一直在试图推荐使用新的 csproj 格式：

将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件

让一个 csproj 项目指定多个开发框架

那么新格式和旧格式究竟有哪些不同使得新的格式如此简洁？

于是，我将新的 csproj 文件结构也进行简化，用思维导图进行了分割。总结成了下图：

比较两个思维导图之后，是不是发现其实两者本是相同的格式。如果忽略我在文字颜色上做的标记，其实两者的差异几乎只在文件开头是否有一个 xml 文件标记（）。我在文字颜色上的标记代表着这部分的部件是否是可选的，白色代表必须，灰色代表可选；而更接近背景色的灰色代表一般情况下都是不需要的。

我把两个思维导图放到一起方便比较：

会发现，传统格式中 xml 声明、Project 节点、Import (props)、PropertyGroup、ItemGroup、Import (targets) 都是必要的，而新格式中只有 Project 节点和 PropertyGroup 是必要的。

是什么导致了这样的差异？在了解 csproj 文件中各个部件的作用之前，这似乎很难回答。

了解 csproj 中的各个部件的作用

xml 声明部分完全没有在此解释的必要了，为兼容性提供了方便，详见：XML - Wikipedia。

接下来，我们不会依照部件出现的顺序安排描述的顺序，而是按照关注程度排序。

PropertyGroup

PropertyGroup 是用来存放属性的地方，这与它的名字非常契合。那么里面放什么属性呢？答案是——什么都能放！

在这里写属性就像在代码中定义属性或变量一样，只要写了，就会生成一个指定名称的属性。

比如，我们写：

walterlv is a 逗比

那么，就会生成一个 Foo 属性，值为字符串 walterlv is a 逗比。至于这个属性有什么用，那就不归这里管了。

这些属性的含义完全是由外部来决定的，例如在旧的 csproj 格式中，编译过程中会使用 TargetFrameworkVersion 属性，以确定编译应该使用的 .NET Framework 目标框架的版本（是 v4.5 还是 v4.7）。在新的 csproj 格式中，编译过程会使用 TargetFrameworks 属性来决定编译应该使用的目标框架（是 net47 还是 netstandard2.0）。具体是编译过程中的哪个环节哪个组件使用了此属性，我们后面会说。

从这个角度来说，如果你没有任何地方用到了你定义的属性，那为什么还要定义它呢？是的——这只是浪费。

PropertyGroup 可以定义很多个，里面都可以同等地放属性。至于为什么会定义多个，原因无外乎两个：

为了可读性——将一组相关的属性放在一起，便于阅读和理解意图（旧的 csproj 谈不上什么可读性）

为了加条件——有的属性在 Debug 和 Release 下不一样（例如条件编译符 DefineConstants）

额外说一下，Debug 和 Release 这两个值其实是在某处一个名为 Configuration 的属性定义的，它们其实只是普通的字符串而已，没什么特殊的意义，只是有很多的 PropertyGroup 加上了 Debug Release 的判断条件才使得不同的 Configuration 具有不同的其他属性，最终表现为编译后的巨大差异。由于 Configuration 属性可以放任意字符串，所以甚至可以定义一个非 Debug 和 Release 的配置（例如用于性能专项测试）也是可以的。

ItemGroup

ItemGroup 是用来指定集合的地方，这与它的名字非常契合。那么这集合里面放什么项呢？答案是——什么都能放！

是不是觉得这句话跟前面的 PropertyGroup 句式一模一样？是的——就是一模一样！csproj 中的两个大头都这样不带语义，几乎可以说明 csproj 文件是不包含语义的，它能够用来做什么事情纯属由其他模块来指定；这为 csproj 文件强大的扩展性提供了格式基础。

既然什么都能放，那我们放这些吧：

walterlv is a 逗比

walterlv is a 天才

天才向左，逗比向右

逗比属性额外加成

于是我们就有 4 个类型为 Foo 的项了，至于这 4 个 Foo 项有什么作用，那就不归这里管了。

这些项的含义与 PropertyGroup 一样也是由外部来决定。具体是哪个外部，我们稍后会说。但是我们依然有一些常见的项可以先介绍介绍：

Reference 引用某个程序集

PackageReference 引用某个 NuGet 包

ProjectReference 引用某个项目

Compile 常规的 C# 编译

None 没啥特别的编译选项，就为了执行一些通用的操作（或者是只是为了在 Visual Studio 列表中能够有一个显示）

Folder 一个空的文件夹，也没啥用（不过标了这个文件夹，Visual Studio 中就能有一个文件夹的显式，即便实际上这个文件夹可能不存在）

ItemGroup 也可以放很多组，一样是为了提升可读性或者增加条件。

Import

你应该注意到在前面的思维导图中，无论是新 csproj 还是旧 csproj 文件，我都写了两个 Import 节点。其实它们本质上是完全一样的，只不过在含义上有不同。前面我们了解到 csproj 文件致力于脱离语义，所以分开两个地方写几乎只是为了可读性考虑。

那么前面那个 Import 和后面的 Import 在含义上有何区别？思维导图的括号中我已说明了含义。前面是为了导入属性（props），后面是为了导入 Targets。属性就是前面 PropertyGroup 中说的那些属性和 ItemGroup 里说的那些项；而 Targets 是新东西，这才是真正用来定义编译流程的关键，由于 Targets 是所有节点里面最复杂的部分，所以我们放到最后再说。

那么，被我们 Import 进来的那些文件是什么呢？用两种扩展名，定义属性的那一种是 .props，定义行为的那一种是 .targets。

这两种文件除了含义不同以外，内容的格式都是完全一样的——而且——就是 csproj 文件的那种格式！没错，也包含 Project、Import、PropertyGroup、ItemGroup、Targets。只不过，相比于对完整性有要求的 csproj 文件来说，这里可以省略更多的节点。由于有 Import 的存在，所以一层一层地嵌套 props 或者 targets 都是可能的。

说了这么多，让我们来看其中两个 .props 文件吧。

先看看旧格式 csproj 文件中第一行一定会 Import 的那个 Microsoft.Common.props。

true

文件太长，做了大量删减，但也可以看到文件格式与 csproj 几乎是一样的。此文件中，根据其他属性的值有条件地定义了另一些属性。

再看看另一个 MSTest 单元测试项目中被隐式 Import 进 csproj 文件中的 .props 文件。（所谓隐式地 Import，只不过是被间接地引入，在 csproj 文件中看不到这个文件名而已。至于如何间接引入，因为涉及到 Targets，所以后面一起说明。）

Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.dll

PreserveNewest

False

Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.Interface.dll

PreserveNewest

False

Microsoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.dll

PreserveNewest

False

此文件中将三个 dll 文件从 MSTest 的 NuGet 包中以链接的形式包含到项目中，并且此文件在 Visual Studio 的解决方案列表中不可见。

可以看出，引入的 props 文件可以实现几乎与 csproj 文件中一样的功能。

那么，既然 csproj 文件中可以完全实现这样的功能，为何还要单独用 props 文件来存放呢？原因显而易见了——为了在多个项目中使用，一处更新，到处生效。所以有没有觉得很好玩——如果把版本号单独放到 props 文件中，就能做到一处更新版本号，到处更新版本号啦！

Target

终于开始说 Target 了。为什么会这么期待呢？因为前面埋下的各种伏笔几乎都要在这一节点得到解释了。

一般来说，Target 节点写在 csproj 文件的末尾，但这个并不是强制的。Targets 是一种非常强大的功能扩展方式，支持 msbuild 预定义的一些指令，支持命令行，甚至支持使用 C# 直接编写（当然编译成 dll 会更方便些），还支持这些的排列组合和顺序安排。而我们实质上的编译过程便全部由这些 Targets 来完成。我们甚至可以直接说——编译过程就是靠这些 Target 的组合来完成的。

如果你希望全面了解 Targets，推荐直接阅读微软的官方文档 MSBuild Targets，而本文只会对其进行一些简单的概述。当然如果你非常感兴趣，还可以阅读我另外几篇关于 Target 使用相关的文章：

如何创建一个基于命令行工具的跨平台的 NuGet 工具包 - 吕毅

如何创建一个基于 MSBuild Task 的跨平台的 NuGet 工具包 - 吕毅

每次都要重新编译？太慢！让跨平台的 MSBuild/dotnet build 的 Target 支持差量编译 - 吕毅

如何最快速地将旧的 NuGet 包 (2.x, packages.config) 升级成新的 NuGet 包 (4.x, PackageReference) - 吕毅

不过，为了简单地理解 Target，我依然需要借用官方文档的例子作为开头。

这份代码定义了一个名为 Construct 的 Target，这是随意取的一个名字，并不重要——但是编译过程中会执行这个 Target。在这个 Target 内部，使用了一个 msbuild 自带的名为 Csc 的 Task。这里我们再次引入了一个新的概念 Task。而 Task 是 Target 内部真正完成逻辑性任务的核心；或者说 Target 其实只是一种容器，本身并不包含编译逻辑，但它的内部可以存放 Task 来实现编译逻辑。一个 Target 内可以放多个 Task，不止如此，还能放 PropertyGroup 和 ItemGroup，不过这是仅在编译期生效的属性和项了。

@(Compile) 是 ItemGroup 中所有 Compile 类型节点的集合。还记得我们在 ItemGroup 小节时说到每一种 Item 的含义由外部定义吗？是的，就是在这里定义的！本身并没有什么含义，但它们作为参数传入到了具体的 Task 之后便有了此 Task 指定的含义。

于是的含义便是调用 msbuild 内置的 C# 编译器编译所有 Compile 类型的项。

如果后面定义了一个跟此名称一样的 Target，那么后一个 Target 就会覆盖前一个 Target，导致前一个 Target 失效。

再次回到传统的 csproj 文件上来，每一个传统格式的 csproj 都有这样一行：

而引入的这份 .targets 文件便包含了 msbuild 定义的各种核心编译任务。只要引入了这个 .targets 文件，便能使用 msbuild 自带的编译任务完成绝大多数项目的编译。你可以自己去查看此文件中的内容，相信有以上 Target 的简单介绍，应该能大致理解其完成编译的流程。这是我的地址：C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\Bin\Microsoft.CSharp.targets。

Project

所有的 csproj 文件都是以 Project 节点为根节点。既然是根节点为何我会在最后才说 Project 呢？因为这可是一个大悬念啊！本文一开始就描述了新旧两款 csproj 文件格式的差异，你也能从我的多篇博客中感受到新格式带来的各种好处；而简洁便是新格式中最大的好处之一。它是怎么做到简洁的呢？

就靠 Project 节点了。

注意到新格式中 Project 节点有 Sdk 属性吗？因为有此属性的存在，csproj 文件才能如此简洁。因为——所谓 Sdk，其实是一大波 .targets 文件的集合。它帮我们导入了公共的属性、公共的编译任务，还帮我们自动将项目文件夹下所有的 **\*.cs 文件都作为 ItemGroup 的项引入进来。

如果你希望看看 Microsoft.NET.Sdk 都引入了哪些文件，可以去本机安装的 msbuild 或 dotnet 的目录下查看。当我使用 msbuild 编译时，我的地址：C:\Program Files\dotnet\sdk\2.1.200\Sdks\Microsoft.NET.Sdk\build\。比如你可以从此文件夹里的 Microsoft.NET.GenerateAssemblyInfo.targets 文件中发现 AssemblyInfo.cs 文件是如何自动生成及生效的。

编译器是如何将这些零散的部件组织起来的？

这里说的编译器几乎只指 msbuild 和 Roslyn，前者基于 .NET Framework，后者基于 .NET Core。不过，它们在处理我们的项目文件时的行为大多是一致的——至少对于通常项目来说如此。

我们前一部分介绍每个部件的时候，已经简单说了其组织方式，这里我们进行一个回顾和总结。

当 Visual Studio 打开项目时，它会解析里面所有的 Import 节点，确认应该引入的 .props 和 .targets 文件都引入了。随后根据 PropertyGroup 里面设置的属性正确显示属性面板中的状态，根据 ItemGroup 中的项正确显示解决方案管理器中的引用列表、文件列表。——这只是 Visual Studio 做的事情。

在编译时，msbuild 或 Roslyn 还会重新做一遍上面的事情——毕竟这两个才是真正的编译器，可不是 Visual Studio 的一部分啊。随后，执行编译过程。它们会按照 Target 指定的先后顺序来安排不同 Target 的执行，当执行完所有的 Target，便完成了编译过程。

新旧 csproj 在编译过程上有什么差异？

相信读完前面两个部分之后，你应该已经了解到在格式本身上，新旧格式之间其实并没有什么差异。或者更严格来说，差异只有一条——新格式在 Project 上指定了 Sdk。真正造成新旧格式在行为上的差别来源于默认为我们项目 Import 进来的那些 .props 和 .targets 不同。新格式通过 Microsoft.NET.Sdk 为我们导入了更现代化的 .props 和 .targets，而旧格式需要考虑到兼容性压力，只能引入旧的那些 .targets。

新的 Microsoft.NET.Sdk 以不兼容的方式支持了各种新属性，例如新的 TargetFrameworks 代替旧的 TargetFrameworkVersion，使得我们的 C# 项目可以脱离 .NET Framework，引入其他各种各样的目标框架，例如 netstandard2.0、net472、uap10.0 等（可以参考从以前的项目格式迁移到 VS2017 新项目格式 - 林德熙）了解可以使用那些目标框架。

新的 Microsoft.NET.Sdk 以不兼容的方式原生支持了 NuGet 包管理。也就是说我们可以在不修改 csproj 的情况之下通过 NuGet 包来扩展 csproj 的功能。而旧的格式需要在 csproj 文件的末尾添加如下代码才可以获得其中一个 NuGet 包功能的支持：

This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.

不过好在 NuGet 4.x 以上版本在安装 NuGet 包时自动为我们在 csproj 中插入了以上代码。

更多资料

如果你在阅读本文时还有更多问题，可以阅读我和朋友的其他相关博客，也可以随时在下方向我留言。如果没有特别原因，我都是在一天之内进行回复。

项目文件中的已知属性（知道了这些，就不会随便在 csproj 中写死常量了） - 吕毅

让一个 csproj 项目指定多个开发框架 - 吕毅

从以前的项目格式迁移到 VS2017 新项目格式 - 林德熙

将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件 - 吕毅

自动将 NuGet 包的引用方式从 packages.config 升级为 PackageReference - 吕毅

posted @

2018-05-19 07:58

walterlv

阅读(9601)

编辑

会员力量，点亮园子希望

刷新页面返回顶部

公告

如何运行 C# 程序 - Visual Studio (Windows) | Microsoft Learn

跳转至主内容

此浏览器不再受支持。

请升级到 Microsoft Edge 以使用最新的功能、安全更新和技术支持。

下载 Microsoft Edge

有关 Internet Explorer 和 Microsoft Edge 的详细信息

退出焦点模式

使用英语阅读

保存

使用英语阅读

保存

打印

Twitter

Facebook

电子邮件

在 Visual Studio 中运行 C# 程序

项目

03/16/2023

7 个参与者

反馈

本文内容

如何运行程序取决于你从什么开始执行、程序的类型，以及你是否想在调试器下运行。最简单的是在 Visual Studio 中生成并运行一个打开的项目，在这种情况下，可执行以下操作：

按 F5，从 Visual Studio 菜单中选择“调试”>“开始执行(调试)”，或在 Visual Studio 工具栏上选择绿色的“开始”箭头和项目名称。

你也可以按 Ctrl+F5，或从 Visual Studio 菜单中选择“调试”>“开始执行(不调试)”，直接运行而不调试。

从项目开始

你可以运行 C# 项目或 .csproj 文件（如果是可运行的程序）。如果项目包含带有 Main 方法的 C# 文件，并且其输出为可执行文件（.exe 文件），则很可能会在项目成功生成后运行该文件。较新版本的 C# 不需要 Main 方法；相反，程序执行从顶级语句开始。请参阅不含 Main 方法的程序。

如果你的程序代码已在 Visual Studio 项目中，请打开该项目。你可以执行以下操作来打开项目：双击或点击 Windows 文件资源管理器中的 .csproj 文件；或者在 Visual Studio 中选择“打开项目”，浏览以找到 .csproj 文件，然后选择该文件。

在 Visual Studio 中加载项目后，如果 Visual Studio 解决方案包含多个项目，请确保将带有 Main 方法的项目设置为启动项目。要设置启动项目，请右键单击“解决方案资源管理器”中的项目名称或节点，然后从上下文菜单中选择“设置为启动项目” 。

要运行程序，请按 Ctrl+F5，从顶部菜单中选择“调试”>“开始执行(不调试)”，或选择绿色的“开始”按钮。

Visual Studio 会尝试生成并运行你的项目。在 Visual Studio 屏幕的底部，生成输出显示在“输出”窗口中，生成错误显示在“错误列表”窗口中。

如果生成成功，应用会以适合项目类型的方式运行。控制台应用在终端窗口中运行，Windows 桌面应用在新的桌面窗口中启动，Web 应用在由 IIS Express 承载的浏览器中运行。

从代码开始

如果是从代码清单、代码文件或少量文件开始，请首先确保该代码来自受信任的源，并且是可运行的程序。具有 Main 方法的任何应用都可能是可运行的程序，但对于当前版本的 C#，不含 Main 方法但具有顶级语句的程序也可以运行。你可以使用“控制台应用程序”模板创建一个项目，以便在 Visual Studio 中使用该应用。

单个文件的代码列表

启动 Visual Studio，并打开一个空的 C# 控制台应用程序项目。

将项目 .cs 文件中的所有代码替换为代码清单或文件的内容。

将项目 .cs 文件重命名为与你的代码文件名一致。

磁盘上有多个代码清单或文件

启动 Visual Studio，并创建适当类型的新项目。如果不确定，请使用 C#“控制台应用程序”。

在新项目中，将项目代码文件中的所有代码替换为第一个代码清单或文件的内容。

重命名项目代码文件，使其与你的代码文件名一致。

对于其余的每个代码文件：

右键单击“解决方案资源管理器”中的项目节点，然后选择“添加”>“现有项”，或选择该项目，然后按 Shift+Alt+A 。

浏览到并选择要导入到项目中的代码文件。

文件夹中有多个文件

如果文件夹中有多个文件，请先查找项目或解决方案文件。 Visual Studio 创建的程序具有项目和解决方案文件。在 Windows 文件资源管理器中，查找扩展名为 .csproj 或 .sln 的文件。双击 .csproj 文件，在 Visual Studio 中打开它。请参阅从 Visual Studio 解决方案或项目开始。

如果代码来自其他开发环境，则没有项目文件。在 Visual Studio 中选择“打开”>“文件夹”，打开该文件夹。请参阅开发代码而无需创建项目或解决方案。

从 GitHub 或 Azure DevOps 存储库开始

如果要运行的代码位于 GitHub 或 Azure DevOps 存储库中，则可以使用 Visual Studio 直接从存储库打开项目。请参阅打开存储库中的项目。

运行程序

要开始生成程序，请按 Visual Studio 工具栏上的绿色“开始”按钮，或者按 F5 或 Ctrl+F5 。使用“开始”按钮或 F5 在调试器下运行程序。

Visual Studio 会尝试在你的项目中生成并运行代码。如果生成不成功，请参阅以下部分，了解有关如何成功生成项目的一些建议。

疑难解答

你的代码可能有错误。或者代码可能是正确的，但它可能依赖于缺少的程序集或 NuGet 包，或者针对其他版本的 .NET。在这些情况下，可以轻松地修复生成。

添加引用

要正确生成，代码必须正确，并具有对库或其他依赖项的正确引用。代码中的红色波浪下划线或错误列表中的条目表明存在错误，即使在编译和运行程序之前也是如此。如果错误与未解析的名称相关，则可能需要添加引用和/或 using 指令。如果代码引用了任何缺失的程序集或 NuGet 包，则需要将这些引用添加到项目。

Visual Studio 会尝试帮助你识别缺少的引用。如果名称未解析，编辑器中会出现灯泡图标。选择灯泡，可以看到有关如何修复此问题的一些建议。解决方法可能是：

添加 using 指令。

添加对程序集的引用。

安装 NuGet 包。

添加 using 指令

下面是缺少的 using 指令的示例。你可以将 using System; 添加到代码文件的开头，以解析无法解析的名称 Console：

较新版本的 C# 支持对一些常用命名空间使用隐式 using 指令，因此，如果在创建项目时选择了该选项，则不需要它们。

添加程序集引用

.NET 引用可以是程序集或 NuGet 包。在源代码中，发布者或作者通常会说明代码所需的程序集以及它所依赖的包。要手动添加对项目的引用，请右键单击“解决方案资源管理器”中的“引用”节点，然后选择“添加引用” 。在“引用管理器”中，找到并添加所需的程序集。

你可以按照使用引用管理器添加或删除引用中的说明查找程序集并添加引用。

添加 NuGet 包

如果 Visual Studio 检测到缺少 NuGet 包，则会显示一个灯泡，并提供安装包的选项：

如果这不能解决问题，或者 Visual Studio 找不到包，请尝试联机搜索包。请参阅在 Visual Studio 中安装和使用 NuGet 包。

使用正确版本的 .NET

由于不同版本的 .NET Framework 具有一定的后向兼容性，因此较新的框架可能会运行针对较旧的框架编写的代码，且不需要进行任何更改。但有时需要针对特定的 .NET Framework 版本。你可能需要安装特定版本的 .NET Framework 或 .NET Core。请参阅修改 Visual Studio。

要更改目标 .NET Framework 版本，请参阅更改目标框架。有关详细信息，请参阅 .NET Framework 目标错误疑难解答。

后续步骤

阅读欢迎使用 Visual Studio IDE，探索 Visual Studio 开发环境。

创建自己的第一个 C# 应用

其他资源

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

其他资源

本文内容

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

理解 C# 项目 csproj 文件格式的本质和编译流程_.csproj-CSDN博客

理解 C# 项目 csproj 文件格式的本质和编译流程

最新推荐文章于 2024-03-07 14:53:15 发布

我心依旧

最新推荐文章于 2024-03-07 14:53:15 发布

阅读量927

点赞数

文章标签：

wpf

开发语言

原文链接：http://www.fogsvc.com/3024.html

版权

本文将直接从 csproj 文件格式的本质来看以上这些问题。

阅读本文，你将：

可以通读 csproj 文件，并说出其中每一行的含义

可以手工修改 csproj 文件，以实现你希望达到的高级功能（更高级的，可以开始写个工具自动完成这样的工作了）

理解新旧 csproj 文件的差异，不至于写工具解析和修改 csproj 文件的时候出现不兼容的错误

csproj 里面是什么？

一、总览 csproj 文件

相信你一定见过传统的 csproj 文件格式。就算你几乎从来没主动去看过里面的内容，在版本管理工具中解冲突时也在里面修改过内容。

不过，既然这篇文章的目标是理解 csproj 文件格式的本质，那我当然不会把这么复杂的文件内容直接给你去阅读。

我已经将整个文件结构进行了极度简化，然后用思维导图进行了分割。总结成了下图，如果先不关注文件的细节，是不是更容易看懂了呢？

如果你此前也阅读过我的其他博客，会发现我一直在试图推荐使用新的 csproj 格式：

将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件

让一个 csproj 项目指定多个开发框架

那么新格式和旧格式究竟有哪些不同使得新的格式如此简洁？

于是，我将新的 csproj 文件结构也进行简化，用思维导图进行了分割。总结成了下图：

我把两个思维导图放到一起方便比较：

是什么导致了这样的差异？在了解 csproj 文件中各个部件的作用之前，这似乎很难回答。

二、了解 csproj 中的各个部件的作用

xml 声明部分完全没有在此解释的必要了，为兼容性提供了方便，详见：XML – Wikipedia。

接下来，我们不会依照部件出现的顺序安排描述的顺序，而是按照关注程度排序。

1.PropertyGroup

PropertyGroup 是用来存放属性的地方，这与它的名字非常契合。那么里面放什么属性呢？答案是——什么都能放！

在这里写属性就像在代码中定义属性或变量一样，只要写了，就会生成一个指定名称的属性。

比如，我们写：

walterlv is a 逗比

那么，就会生成一个 Foo 属性，值为字符串 walterlv is a 逗比。至于这个属性有什么用，那就不归这里管了。

从这个角度来说，如果你没有任何地方用到了你定义的属性，那为什么还要定义它呢？是的——这只是浪费。

PropertyGroup 可以定义很多个，里面都可以同等地放属性。至于为什么会定义多个，原因无外乎两个：

为了可读性——将一组相关的属性放在一起，便于阅读和理解意图（旧的 csproj 谈不上什么可读性）

为了加条件——有的属性在 Debug 和 Release 下不一样（例如条件编译符 DefineConstants）

2.ItemGroup

ItemGroup 是用来指定集合的地方，这与它的名字非常契合。那么这集合里面放什么项呢？答案是——什么都能放！

既然什么都能放，那我们放这些吧：

walterlv is a 逗比walterlv is a 天才天才向左，逗比向右逗比属性额外加成

于是我们就有 4 个类型为 Foo 的项了，至于这 4 个 Foo 项有什么作用，那就不归这里管了。

这些项的含义与 PropertyGroup 一样也是由外部来决定。具体是哪个外部，我们稍后会说。但是我们依然有一些常见的项可以先介绍介绍：

Reference 引用某个程序集PackageReference 引用某个 NuGet 包ProjectReference 引用某个项目Compile 常规的 C# 编译None 没啥特别的编译选项，就为了执行一些通用的操作（或者是只是为了在 Visual Studio 列表中能够有一个显示）Folder 一个空的文件夹，也没啥用（不过标了这个文件夹，Visual Studio 中就能有一个文件夹的显式，即便实际上这个文件夹可能不存在）

ItemGroup 也可以放很多个，一样是为了提升可读性或者增加条件。

3.Import

那么，被我们 Import 进来的那些文件是什么呢？用两种扩展名，定义属性的那一种是 .props，定义行为的那一种是 .targets。

说了这么多，让我们来看其中两个 .props 文件吧。

先看看旧格式 csproj 文件中第一行一定会 Import 的那个 Microsoft.Common.props。

truetruetruetruetrue

文件太长，做了大量删减，但也可以看到文件格式与 csproj 几乎是一样的。此文件中，根据其他属性的值有条件地定义了另一些属性。

Microsoft.VisualStudio.TestPlatform.MSTest.TestAdapter.dllPreserveNewestFalseMicrosoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.Interface.dllPreserveNewestFalseMicrosoft.VisualStudio.TestPlatform.MSTestAdapter.PlatformServices.dllPreserveNewestFalse

此文件中将三个 dll 文件从 MSTest 的 NuGet 包中以链接的形式包含到项目中，并且此文件在 Visual Studio 的解决方案列表中不可见。

可以看出，引入的 props 文件可以实现几乎与 csproj 文件中一样的功能。

4.Target

终于开始说 Target 了。为什么会这么期待呢？因为前面埋下的各种伏笔几乎都要在这一节点得到解释了。

一般来说，Target 节点写在 csproj 文件的末尾，但这个并不是强制的。Targets 是一种非常强大的功能扩展方式，支持 msbuild 预定义的一些指令，支持命令行，甚至支持使用 C# 直接编写（当然编译成 dll 会更方便些），还支持这些的排列组合和顺序安排。而我们实质上的编译过程便全部由这些 Targets 来完成。我们甚至可以直接说——编译过程就是靠这些 Target 的组合来完成的。

如果你希望全面了解 Targets，推荐直接阅读微软的官方文档 MSBuild Targets，而本文只会对其进行一些简单的概述（我即将用另一篇博客来详细讲解，不然这篇就太长了）。

不过，为了简单地理解 Target，我依然需要借用官方文档的例子作为开头。

这份代码定义了一个名为 Construct 的 Target，这是随意取的一个名字，并不重要——但是编译过程中会执行这个 Target。在这个 Target 内部，使用了一个 msbuild 自带的名为 Csc 的 Task。这里我们再次引入了一个新的概念 Task。而 Task 是 Target内部真正完成逻辑性任务的核心；或者说 Target 其实只是一种容器，本身并不包含编译逻辑，但它的内部可以存放 Task 来实现编译逻辑。一个 Target 内可以放多个 Task，不止如此，还能放 PropertyGroup 和 ItemGroup，不过这是仅在编译期生效的属性和项了。

于是的含义便是调用 msbuild 内置的 C# 编译器编译所有 Compile 类型的项。

如果后面定义了一个跟此名称一样的 Target，那么后一个 Target 就会覆盖前一个 Target，导致前一个 Target 失效。

再次回到传统的 csproj 文件上来，每一个传统格式的 csproj 都有这样一行：

5.Project

就靠 Project 节点了。

编译器是如何将这些零散的部件组织起来的？

我们前一部分介绍每个部件的时候，已经简单说了其组织方式，这里我们进行一个回顾和总结。

新旧 csproj 在编译过程上有什么差异？

新的 Microsoft.NET.Sdk 以不兼容的方式支持了各种新属性，例如新的 TargetFrameworks 代替旧的 TargetFrameworkVersion，使得我们的 C# 项目可以脱离 .NET Framework，引入其他各种各样的目标框架，例如 netstandard2.0、net472、uap10.0 等（可以参考从以前的项目格式迁移到 VS2017 新项目格式 – 林德熙）了解可以使用那些目标框架。

不过好在 NuGet 4.x 以上版本在安装 NuGet 包时自动为我们在 csproj 中插入了以上代码。

优惠劵

我心依旧

关注

踩

觉得还不错?

一键收藏

知道了

理解 C# 项目 csproj 文件格式的本质和编译流程

写了这么多个 C# 项目，是否对项目文件 csproj 有一些了解呢？Visual Studio 是怎么让 csproj 中的内容正确显示出来的呢？更深入的，我能够自己扩展 csproj 的功能吗？本文将直接从 csproj 文件格式的本质来看以上这些问题。

复制链接

扫一扫

获取C#项目包含的所有程序文件的源代码

12-12

获取C#项目包含的所有程序文件的源代码，包含项目文件SLN的解析，解决方案CSPROJ的解析，XML命名空间的适配。

“csproj文件究竟是做什么用的”

weixin_30413739的博客

08-17

572

csproj文件大家应该不会陌生，那就是C#项目文件的扩展名，它是“C Sharp Project”的缩写。那么它究竟是给谁用的呢？那是给开发工具用的，例如我们在熟悉不过的Visual Studio，以及大家可以没有接触过，但是应该都听说过的MSBuild.exe。Visual Studio会根据csproj里的XML定义来管理项目文件以及相关其他一些种类非常丰富的数据及操作，MSBuild也会...

参与评论

您还未登录，请先

后发表或查看评论

csproj内容解析

sgmcumt的博客

10-10

6980

文章目录指定目标框架指定多个目标框架新增其它项目属性项目引用普通NuGet包引用添加引用NuGet包的条件托管程序集引用添加COM组件引用本机文件引用项目引用编译嵌入式资源None输入其它

使用C#很长时间都没太关注，最近查看一些开源软件，有时候需要在csproj更改项目的配置信息，不得不熟悉里面的配置内容。

如果只是想了解csproj文件的配置项的含义，不太关注配置内容的细节，可以查看理解 C#...

vs2019 .NET CORE csproj 文件编辑点

pehao的博客

10-19

1297

1. 引用框架,Microsoft.NETCore.App,手动打开xxx.csproj文件,添加以下节点

2.输出时,不输出\bin\debug\netcore3.1目录

netc

MSBuild 中的 PropertyGroup、ItemGroup 和 ItemMetadata

aijianxie8808的博客

04-22

318

在软件项目不断的进展中，MSBuild 脚本可能几个月都不会被修改，因为通常编译和发布的目录是不经常变化的。

但，一旦某天你需要修改了，看到那一堆 $(Something)、 @(Something)、%(Something) 是相当的头大，不得不搜索 MSDN 才能找到合理的用法。

每次看到下面这样的语法，我都感觉，有必要把语法设计成这样吗？

.csproj 文件

.NET 项目 SDK 概述 | Microsoft Learn

跳转至主内容

此浏览器不再受支持。

请升级到 Microsoft Edge 以使用最新的功能、安全更新和技术支持。

下载 Microsoft Edge

有关 Internet Explorer 和 Microsoft Edge 的详细信息

退出焦点模式

使用英语阅读

保存

使用英语阅读

保存

打印

Twitter

Facebook

电子邮件

.NET 项目 SDK

项目

04/11/2023

7 个参与者

反馈

本文内容

.NET Core 和 .NET 5 及更高版本项目与软件开发工具包 (SDK) 关联。每个项目 SDK 都是一组 MSBuild 目标和相关的任务，它们负责编译、打包和发布代码。引用项目 SDK 的项目有时称为“SDK 样式的项目”。

可用的 SDK

有以下 SDK 可用：

描述

存储库

Microsoft.NET.Sdk

.NET SDK

https://github.com/dotnet/sdk

Microsoft.NET.Sdk.Web

.NET Web SDK

https://github.com/dotnet/sdk

Microsoft.NET.Sdk.BlazorWebAssembly

The .NET Blazor WebAssembly SDK

https://github.com/dotnet/aspnetcore

Microsoft.NET.Sdk.Razor

.NET Razor SDK

https://github.com/dotnet/aspnetcore

Microsoft.NET.Sdk.Worker

.NET 辅助角色服务 SDK

Microsoft.NET.Sdk.WindowsDesktop

.NET 桌面 SDK，其中包括 Windows 窗体 (WinForms) 和 Windows Presentation Foundation (WPF)。*

https://github.com/dotnet/winforms 和 https://github.com/dotnet/wpf

.NET SDK 是 .NET 的基本 SDK。其他 SDK 引用 .NET SDK，与其他 SDK 关联的项目具有所有可用的 .NET SDK 属性。例如，Web SDK 依赖于 .NET SDK 和 Razor SDK。

你还可以创建自己的 SDK，并通过 NuGet 进行分发。

* 从 .NET 5 开始，Windows 窗体和 Windows Presentation Foundation (WPF) 项目应指定 .NET SDK (Microsoft.NET.Sdk)，而不是 Microsoft.NET.Sdk.WindowsDesktop。对于这些项目，将 TargetFramework 设置为 net5.0-windows 并将 UseWPF 或 UseWindowsForms 设置为 true 的操作会自动导入 Windows 桌面 SDK。如果你的项目面向 .NET 5 或更高版本，并指定 Microsoft.NET.Sdk.WindowsDesktop SDK，则会收到生成警告 NETSDK1137。

项目文件

.NET 项目基于 MSBuild 格式。具有扩展名（如用于 C# 项目的 .csproj 和用于 F# 项目的 .fsproj）的项目文件都是 XML 格式的。 MSBuild 项目文件的根元素是 Project 元素。 Project 元素有一个可选的 Sdk 属性，该属性指定要使用的 SDK（和版本）。若要使用 .NET 工具并构建你的代码，请将 Sdk 属性设置为可用 SDK 表中的其中一个 ID。

...

若要指定来自 NuGet 的 SDK，请在名称末尾包含版本，或者在 global.json 文件中指定名称和版本。

...

另一种指定 SDK 的方法是使用顶层 Sdk 元素：

...

以这些方式之一引用 SDK 可以极大地简化 .NET 的项目文件。在评估项目时，MSBuild 在项目文件的顶部和底部分别为 Sdk.props 和 Sdk.targets 添加隐式导入。

...

提示

在 Windows 计算机上，Sdk.props 和 Sdk.targets 文件位于 %ProgramFiles%\dotnet\sdk\[version]\Sdks\Microsoft.NET.Sdk\Sdk 文件夹中。

预处理项目文件

使用 dotnet msbuild -preprocess 命令，可以看到 MSBuild 在包含 SDK 及其目标之后所显示的完全扩展的项目。 dotnet msbuild 命令的预处理开关显示导入的文件、文件源及其在生成中的参与情况，而无需实际生成项目。

如果项目有多个目标框架，请将命令的结果指定为 MSBuild 属性，使其仅侧重于框架之一。例如：

dotnet msbuild -property:TargetFramework=netcoreapp2.0 -preprocess:output.xml

默认包含和排除的内容

SDK 中定义了 Compile 项、嵌入的资源和 None 项默认包含和排除的内容。与非 SDK .NET 框架项目不同，你无需在项目文件中指定这些项，因为默认设置涵盖了最常见的用例。此行为使得项目文件更小、更易于理解和手动编辑（如需要）。

下表显示在 .NET SDK 中包含和排除的元素和 glob：

元素

包含 glob

排除 glob

删除 glob

Compile

**/*.cs（或其他语言扩展名）

**/*.user; **/*.*proj; **/*.sln; **/*.vssscc

空值

EmbeddedResource

**/*.resx

**/*.user; **/*.*proj; **/*.sln; **/*.vssscc

空值

None

**/*

**/*.user; **/*.*proj; **/*.sln; **/*.vssscc

**/*.cs; **/*.resx

注意

默认情况下，由 $(BaseOutputPath) 和 $(BaseIntermediateOutputPath) MSBuild 属性表示的 ./bin 和 ./obj 文件夹不包含在 glob 中。排除由 DefaultItemExcludes 属性表示。

.NET 桌面 SDK 对于 WPF 有更多包含和排除的内容。有关详细信息，请参阅 WPF 默认包含和排除的内容。

生成错误

如果在项目文件中显式定义这些项中的任何项，可能会出现类似于以下内容的“NETSDK1022”生成错误：

包含重复的“Compile”项。默认情况下，.NET SDK 包括项目目录中的“Compile”项。可从项目文件中删除这些项，或如果想要在项目文件中显式包括它们，则将“EnableDefaultCompileItems”属性设为“false”。

包含重复的“EmbeddedResource”项。默认情况下，.NET SDK 包括项目目录中的“EmbeddedResource”项。可从项目文件中删除这些项，或如果想要在项目文件中显式包括它们，则将“EnableDefaultEmbeddedResourceItems”属性设为“false”。

若要解决此错误，请执行以下操作之一：

删除与上表中列出的隐式项匹配的显式 Compile、EmbeddedResource 或 None 项。

若要禁用所有隐式文件包含，请将 EnableDefaultItems 属性设置为 false：

false

若要指定某些文件通过应用发布，仍可以使用相应的已知 MSBuild 机制来实现（例如 Content 元素）。

可选择仅禁用 Compile、EmbeddedResource 或 None glob，方法是将 EnableDefaultCompileItems、EnableDefaultEmbeddedResourceItems 或 EnableDefaultNoneItems 属性设置为 false：

false

如果仅禁用 Compile glob，则 Visual Studio 中的解决方案资源管理器仍将 *.cs 项显示为项目的一部分，并作为 None 项包含在内。若要禁用隐式 None glob，请将 EnableDefaultNoneItems 也设置为 false。

隐式 using 指令

从 .NET 6 开始，隐式 global using 指令将添加到新的 C# 项目中。这意味着可以使用这些命名空间中定义的类型，而无需指定完全限定的名称或手动添加 using 指令。隐式方面是指向项目的 obj 目录中生成的文件添加 global using 指令这一事实。

为使用以下 SDK 之一的项目添加隐式 global using 指令：

Microsoft.NET.Sdk

Microsoft.NET.Sdk.Web

Microsoft.NET.Sdk.Worker

Microsoft.NET.Sdk.WindowsDesktop

为基于项目 SDK 的一组默认命名空间中的每个命名空间添加 global using 指令。下表显示了这些默认命名空间。

SDK 中 IsInRole 中的声明

默认命名空间

Microsoft.NET.Sdk

SystemSystem.Collections.GenericSystem.IOSystem.LinqSystem.Net.HttpSystem.ThreadingSystem.Threading.Tasks

Microsoft.NET.Sdk.Web

System.Net.Http.JsonMicrosoft.AspNetCore.BuilderMicrosoft.AspNetCore.HostingMicrosoft.AspNetCore.HttpMicrosoft.AspNetCore.RoutingMicrosoft.Extensions.ConfigurationMicrosoft.Extensions.DependencyInjectionMicrosoft.Extensions.HostingMicrosoft.Extensions.Logging

Microsoft.NET.Sdk.Worker

Microsoft.Extensions.ConfigurationMicrosoft.Extensions.DependencyInjectionMicrosoft.Extensions.HostingMicrosoft.Extensions.Logging

Microsoft.NET.Sdk.WindowsDesktop（Windows 窗体）

Microsoft.NET.Sdk 命名空间System.DrawingSystem.Windows.Forms

Microsoft.NET.Sdk.WindowsDesktop (WPF)

Microsoft.NET.Sdk 命名空间已删除 System.IO已删除 System.Net.Http

若要禁用此功能，或要在现有的 C# 项目中启用隐式 global using 指令，可通过 ImplicitUsingsMSBuild 属性实现。

可以通过向项目文件添加 Using 项（或针对 Visual Basic 项目添加 Import 项）来指定其他隐式 global using 指令，例如：

隐式包引用

如果以 .NET Core 1.0 - 2.2 或 .NET Standard 1.0 - 2.0 为目标，则 .NET SDK 会添加对某些元包的隐式引用。元包是一种基于框架的包，其中只包含对其他包的依赖项。元包根据项目文件的 TargetFramework 或 TargetFrameworks 属性中指定的目标框架被隐式引用。

netcoreapp2.1

netcoreapp2.1;net462

如果需要，可以使用 DisableImplicitFrameworkReferences 属性来禁用隐式包引用，并只添加对所需的框架或包的显式引用。

建议：

如果以 .NET Framework、.NET Core 1.0 - 2.2 或 .NET Standard 1.0 - 2.0 为目标，不要通过项目文件中的项添加对 Microsoft.NETCore.App 或 NETStandard.Library 元包的显式引用。对于 .NET Core 1.0 - 2.2 和 .NET Standard 1.0 - 2.0 项目，这些元包被隐式引用。对于 .NET Framework 项目，如果在使用基于 .NET Standard 的 NuGet 包时需要任何版本的 NETStandard.Library，则 NuGet 会自动安装相应版本。

如果在以 .NET Core 1.0 - 2.2 为目标时需要特定版本的运行时，请在项目中使用属性（例如，1.0.4），而不是引用元包。例如，如果在使用独立式部署，则可能需要特定补丁版本的 1.0.0 LTS 运行时。

如果在以 .NET Standard 1.0 - 2.0 为目标时需要特定版本的 NETStandard.Library 元包，则可以使用属性，并设置所需的版本。

生成事件

在 SDK 样式的项目中，请使用名为 PreBuild 或 PostBuild 的 MSBuild 目标，并设置 PreBuild 的 BeforeTargets 属性或 PostBuild 的 AfterTargets 属性。

注意

可以为 MSBuild 目标使用任何名称。但是，Visual Studio IDE 会识别 PreBuild 和 PostBuild 目标，因此通过使用这些名称，可以在 IDE 中编辑命令。

不建议在 SDK 样式的项目中使用属性 PreBuildEvent 和 PostBuildEvent，因为无法解析 $(ProjectDir) 这样的宏。例如，以下代码是不受支持的：

"$(ProjectDir)PreBuildEvent.bat" "$(ProjectDir)..\" "$(ProjectDir)" "$(TargetDir)"

自定义生成

可以通过多种方式自定义生成。建议通过将属性作为参数传递给 msbuild 或 dotnet 命令来重写该属性。还可以将属性添加到项目文件或 Directory.Build.props 文件中。有关 .NET 项目的有用属性列表，请参见 .NET SDK 项目的 MSBuild 参考。

提示

从命令行创建新的 Directory.Build.props 文件的一种简单方法是使用存储库根目录中的命令 dotnet new buildprops。

自定义目标

.NET 项目可以打包自定义的 MSBuild 目标和属性，以供使用该包的项目使用。如果要执行以下操作，请使用此类型的可扩展性：

扩展生成过程。

访问生成过程的工件，如生成的文件。

检查调用生成的配置。

通过在项目的生成文件夹中以 .targets 或 .props（例如 Contoso.Utility.UsefulStuff.targets）的形式放置文件，可以添加自定义生成目标或属性。

以下 XML 是 .csproj 文件中的一个片段，该文件指示 dotnet pack 命令打包的内容。元素将目标文件放入包内的生成文件夹中。元素将程序集和 .json 文件放入生成文件夹。

...

true

build\

true

build\

...

若要在项目中使用自定义目标，请添加指向包及其版本的 PackageReference 元素。与工具不同，自定义目标包包含在消费项目的依赖项闭包中。

你可以配置自定义目标的使用方式。由于它是 MSBuild 目标，因此会依赖于给定的目标并在另一个目标后运行，也可使用 dotnet msbuild -t: 命令手动调用。若要提供更好的用户体验，可以合并基于项目的工具和自定义目标。在此方案中，每个项目工具接受所需的任何参数，并将其转换为执行目标所需的 dotnet msbuild 调用。有关此类协同作用的示例，请访问 dotnet-packer 项目中的 2016 年编程马拉松 MVP 峰会示例存储库。

请参阅

自定义您的生成过程 (MSBuild)

如何使用 MSBuild 项目 SDK

使用 NuGet 打包自定义 MSBuild 目标和属性

在 GitHub 上与我们协作

可以在 GitHub 上找到此内容的源，还可以在其中创建和查看问题和拉取请求。有关详细信息，请参阅参与者指南。

.NET

提出文档问题

提供产品反馈

反馈

Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.

提交和查看相关反馈

此产品

此页面

查看所有页面反馈

其他资源

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

其他资源

本文内容

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

常用的 MSBuild 项目属性 - MSBuild | Microsoft Learn

跳转至主内容

此浏览器不再受支持。

请升级到 Microsoft Edge 以使用最新的功能、安全更新和技术支持。

下载 Microsoft Edge

有关 Internet Explorer 和 Microsoft Edge 的详细信息

退出焦点模式

语言

使用英语阅读

保存

使用英语阅读

保存

打印

Twitter

Facebook

电子邮件

常用的 MSBuild 项目属性

项目

06/06/2023

19 个参与者

反馈

本文内容

下表列出了在 Visual Studio 项目文件中定义的或者在 MSBuild 提供的 .targets 文件中包括的经常使用的属性。

Visual Studio 中的项目文件（.csproj、.vbproj、vcxproj 等）包含你使用 IDE 生成项目时运行的 MSBuild XML 代码。项目通常会导入一个或多个 .targets 文件以定义它们的生成进程。有关详细信息，请参阅 MSBuild .Targets 文件。

在设置属性值时，请记住，可以在许多导入的文件中设置、重置或使用公共属性。因此，设置属性的位置非常重要，可以在项目文件、Directory.Build.props 或其他导入文件中进行设置。如果要在某个位置设置属性但未获得预期结果，请考虑在项目导入的所有文件中更改或使用该属性的位置和方式，包括在使用 Sdk 特性时隐式添加的导入。请参阅选择将属性添加到 .props 文件或 .targets 文件。预处理可帮助完成此操作（请参阅 MSBuild 命令行参考中的 /preprocess 或 /pp 命令行选项）。

通用属性和参数的列表

属性或参数名

项目类型

描述

AdditionalLibPaths

.NET

指定其他文件夹，编译器将在这些文件夹中查找引用程序集。

AddModules

.NET

使编译器让指定文件中的所有类型信息可供正在编译的项目使用。此属性等效于 /addModules 编译器开关。

ALToolPath

.NET

AL.exe 的路径。此属性将替代 AL.exe 的当前版本，从而允许使用其他版本。

ApplicationIcon

.NET

要传递给编译器以作为 Win32 图标嵌入的 .ico 图标文件。该属性等效于 /win32icon 编译器开关。

ApplicationManifest

全部

指定用于生成外部用户帐户控制 (UAC) 清单信息的文件的路径。仅适用于面向 Windows Vista 的 Visual Studio 项目。在大多数情况，该清单是嵌入的。但如果使用免注册的 COM 或 ClickOnce 部署，则该清单可以是随应用程序程序集一起安装的外部文件。有关详细信息，请参阅本文中的 NoWin32Manifest 属性。

AssemblyOriginatorKeyFile

.NET

指定用于为程序集（.snk 或 .pfx）签名并传递给 ResolveKeySource 任务的文件，以便生成用于对程序集签名的实际密钥。

AssemblySearchPaths

.NET

要在生成时引用程序集解析期间搜索的位置列表。路径在此列表中的出现顺序是有含义的，因为先列出的路径优先于后列出的条目。

AssemblyName

.NET

生成项目后的最终输出程序集的名称。

属性或参数名

项目类型

说明

BaseAddress

.NET

指定主输出程序集的基址。此属性等效于 /baseaddress 编译器开关。

BaseIntermediateOutputPath

全部

在其中创建所有配置特定的中间输出文件夹的顶级文件夹。默认值为 obj\。下面的代码是一个示例：c:\xyz\obj\

BaseOutputPath

全部

指定输出文件的基路径。如果已设置，MSBuild 将使用 OutputPath = $(BaseOutputPath)\$(Configuration)\。示例语法：c:\xyz\bin\

BuildInParallel

全部

一个布尔值，指示在使用多处理器 MSBuild 时并行生成还是清理项目引用。默认值为 true，该值表示如果系统有多个核心或处理器，则将并行生成项目。

BuildProjectReferences

全部

一个布尔值，指示是否由 MSBuild 生成项目引用。如果在 Visual Studio 集成开发环境 (IDE) 中生成项目，则自动设置为 false；否则设置为 true。可以在命令行上指定 -p:BuildProjectReferences=false 以避免检查引用的项目是否为最新。

属性或参数名

项目类型

说明

CleanFile

全部

将用作“清理缓存”的文件的名称。清理缓存是要在清理操作期间删除的已生成文件的列表。该文件由生成过程放在中间输出路径中。此属性只指定没有路径信息的文件名。

CodePage

.NET

指定要用于编译中所有源代码文件的代码页。此属性等效于 /codepage 编译器开关。

CompilerResponseFile

.NET

可以传递给编译器任务的可选响应文件。

Configuration

全部

正在生成的配置，通常为 Debug 或 Release，但可以在解决方案和项目级别进行配置。

CscToolPath

C# 编译器 csc.exe 的路径。

CustomAfterMicrosoftCommonTargets

全部

要在公用目标导入后自动导入的项目文件或目标文件的名称。

CustomBeforeMicrosoftCommonTargets

全部

要在公用目标导入前自动导入的项目文件或目标文件的名称。

属性或参数名

项目类型

说明

DebugSymbols

全部

一个布尔值，指示是否由生成来生成符号。在命令行中设置 -p:DebugSymbols=false 会禁止生成程序数据库 (.pdb) 符号文件。

DebugType

全部

定义要生成的调试信息的级别。有效值为“full”、“pdbonly”、“portable”、“embedded”和“none”。

DefineConstants

.NET

定义条件编译器常数。符号/值对是使用从属语言语法指定的，并且彼此之间用分号分隔： C#：symbol1; symbol2 Visual Basic：symbol1 = value1, symbol2 = value2 该属性等效于 /define 编译器开关。

DefineDebug

全部

一个布尔值，指示是否定义 DEBUG 常量。

DefineTrace

全部

一个布尔值，指示是否定义 TRACE 常量。

DelaySign

.NET

一个布尔值，指示是否对程序集进行延迟签名，而不对其进行完整签名。

Deterministic

.NET

一个布尔值，指示编译器是否为相同的输入生成相同的程序集。此参数对应于编译器的 /deterministic 开关。

DirectoryBuildPropsPath

全部

指定 Directory.Build.props 文件的路径；如果已定义，则此属性将替代默认搜索算法。请参阅自定义生成。

DirectoryBuildTargetsPath

全部

指定 Directory.Build.targets 文件的路径；如果已定义，则此属性将替代默认搜索算法。请参阅自定义生成。

DisableFastUpToDateCheck

全部

一个只适用于 Visual Studio 的布尔值。 Visual Studio 生成管理器使用名为 FastUpToDateCheck 的进程来确定项目是否必须重新生成才能保持最新。与使用 MSBuild 相比，此进程能更快地确定这一点。通过将 DisableFastUpToDateCheck 属性设置为 true，可以跳过 Visual Studio 生成管理器，并强制生成管理器使用 MSBuild 来确定项目是否为最新版本。

DocumentationFile

.NET

作为 XML 文档文件生成的文件的名称。此名称只包含文件名，不包含路径信息。

属性或参数名

项目类型

说明

ErrorReport

.NET

指定编译器任务报告内部编译器错误的方式。有效值为“prompt”、“send”或“none”。此属性等效于 /errorreport 编译器开关。

ExcludeDeploymentUrl

.NET

GenerateDeploymentManifest 任务会在项目文件包含下列任何元素时向部署清单中添加 deploymentProvider 标记： - UpdateUrl- InstallUrl- PublishUrl 不过，使用 ExcludeDeploymentUrl，可以防止 deploymentProvider 标记添加到部署清单，即使指定了任何上述 URL。为此，请将以下属性添加到项目文件： true 注意：ExcludeDeploymentUrl 在 Visual Studio IDE 中未显示，并且仅可通过手动编辑项目文件进行设置。设置此属性不影响在 Visual Studio 中发布；即 deploymentProvider 标记仍将添加到 PublishUrl 指定的 URL。

FileAlignment

.NET

指定输出文件各部分的对齐位置，以字节为单位。有效值为 512、1024、2048、4096、8192。此属性等效于 /filealignment 编译器开关。

FrameworkPathOverride

Visual Basic

指定 mscorlib.dll 和 microsoft.visualbasic.dll 的位置。此参数等效于 vbc.exe 编译器的 /sdkpath 开关。

GenerateDocumentation

.NET

一个布尔型参数，指示是否由生成来生成文档。如果设置为 true，生成过程将生成文档信息，并将此信息与生成任务所创建的可执行文件或库的名称一同放置在 .xml 文件中。

GenerateFullPaths

使用 -fullpaths 编译器选项为输出中的文件名生成完整路径。

GenerateSerializationAssemblies

.NET

指示是否应通过 SGen.exe 生成 XML 序列化程序集，它可以设置为开、自动或关。此属性用于仅面向 .NET Framework 的程序集。要生成 .NET Standard 或 .NET Core 程序集的 XML 序列化程序集，请参考 Microsoft.XmlSerializer.Generator NuGet 包。

属性或参数名

项目类型

说明

ImportDirectoryBuildProps

全部

一个布尔值，指示是否导入 Directory.Build.props 文件。请参阅自定义生成。

ImportDirectoryBuildTargets

全部

一个布尔值，指示是否导入 Directory.Build.targets 文件。请参阅自定义生成。

IntermediateOutputPath

全部

如果未指定路径，则为从 BaseIntermediateOutputPath 派生的完整中间输出路径。例如 obj\debug\。

KeyContainerName

全部

强名称密钥容器的名称。

KeyOriginatorFile

全部

强名称密钥文件的名称。

ModuleAssemblyName

.NET

要将编译好的模块并入其中的程序集的名称。该属性等效于 /moduleassemblyname 编译器开关。

MSBuildProjectExtensionsPath

全部

指定项目扩展所在的路径。默认情况下，该路径与 BaseIntermediateOutputPath 具有相同值。

MSBuildTreatWarningsAsErrors

全部

一个布尔值，告知 MSBuild 将所有警告视为错误，除非它们被禁止显示。

MSBuildWarningsAsErrors

全部

指定将被视为错误的警告代码列表。用分号分隔多个警告。如果使用 .NET SDK 属性 WarningsAsErrors，则 MSBuildWarningsAsErrors 将默认为 WarningsAsErrors 的值。

MSBuildWarningsAsMessages

全部

通过将警告代码视为低重要性消息来指定要禁止显示的警告代码列表。用分号分隔多个警告。请注意，使用此属性无法禁止显示 MSBuild 发出的某些警告；要将其禁止显示，请使用命令行开关 -warnAsMessage。如果使用 .NET SDK 属性 NoWarn，则 MSBuildWarningsAsMessages 将默认为 NoWarn 的值。

属性或参数名

项目类型

说明

NoLogo

全部

一个指示是否关闭编译器徽标的布尔值。此属性等效于 /nologo 编译器开关。

NoStdLib

.NET

一个指示是否避免引用标准库 (mscorlib.dll) 的布尔值。默认值为 false。

NoVBRuntimeReference

Visual Basic

一个布尔值，指示是否应包括 Visual Basic 运行时 (Microsoft.VisualBasic.dll) 作为项目中的引用。

NoWarn

.NET

禁止显示指定的警告。只有警告标识符的数值部分是必须指定的。多个警告之间用分号分隔。此参数对应于编译器的 /nowarn 开关。

NoWin32Manifest

.NET

一个布尔值，指示是否将用户帐户控制 (UAC) 清单信息嵌入在应用程序的可执行文件中。仅适用于面向 Windows Vista 的 Visual Studio 项目。在使用 ClickOnce 和免注册的 COM 部署的项目中，将忽略此元素。 False（默认值）指示是否将用户帐户控制 (UAC) 清单信息嵌入在应用程序的可执行文件中。 True 指定不嵌入 UAC 清单信息。此属性仅适用于面向 Windows Vista 的 Visual Studio 项目。在使用 ClickOnce 和免注册的 COM 部署的项目中，将忽略此属性。只有在不需要 Visual Studio 在应用程序的可执行文件中嵌入任何清单信息时，才应该添加 NoWin32Manifest；此过程称为“虚拟化”。若要使用虚拟化，请按照下列方式设置和： - 对于 Visual Basic 项目，请删除节点。（在 Visual Basic 项目中，如果存在节点，则忽略。）- 对于 C# 项目，将设置为 False，将设置为 True。（在 C# 项目中，会替代。）此属性等效于 vbc.exe 的 /nowin32manifest 编译器开关。

Optimize

.NET

一个布尔值，在设置为 true 时，允许进行编译器优化。此属性等效于 /optimize 编译器开关。

OptionCompare

VisualBasic

指定如何进行字符串比较。有效值为“binary”或“text”。此属性等效于 vbc.exe 的 /optioncompare 编译器开关。

OptionExplicit

Visual Basic

一个布尔值，设置为 true 时，要求在源代码中显式声明变量。此属性等效于 /optionexplicit 编译器开关。

OptionInfer

Visual Basic

一个布尔值，设置为 true 时，允许进行变量的类型推理。此属性等效于 /optioninfer 编译器开关。

OptionStrict

Visual Basic

一个布尔值，设置为 true 时，将使得生成任务强制使用严格类型语义来限制隐式类型转换。此属性等效于 vbc.exe 编译器的 /optionstrict 开关。

OutDir

全部

指示项目或解决方案的最终输出位置。在生成解决方案时，可以使用 OutDir 将多个项目输出收集到一个位置。此外，OutDir 包含在用于解析引用的 AssemblySearchPaths 中。例如 bin\Debug。

OutputPath

全部

相对于项目目录，例如 bin\Debug 或非 AnyCPU 版本中的 bin\Debug\$(Platform)，指定输出目录的路径。

OutputType

全部

指定输出文件的文件格式。此参数可以具有下列值之一： - Library。创建一个代码库。（默认值）。- Exe。创建控制台应用程序。- Module。创建一个模块。- Winexe。创建一个基于 Windows 的程序。对于 C# 和 Visual Basic，此属性等效于 /target 开关。输出类型可以通过推理自动重写。请参阅对于 WPF 和 WinForms 应用，OutputType 设置为 WinExe。通过将 DisableWinExeOutputInference 设置为 true 来禁用推理。

OverwriteReadOnlyFiles

全部

一个布尔值，指示要让生成覆盖只读文件还是触发错误。

属性或参数名

项目类型

说明

PathMap

.NET

指定如何将物理路径映射到编译器输出的源路径名称。此属性等效于编译器的 /pathmap 开关。

PdbFile

.NET

正在发出的 .pdb 文件的文件名。此属性等效于 csc.exe 编译器的 /pdb 开关。

Platform

全部

针对其进行生成操作的操作系统。 .NET Framework 生成示例包括“任何 CPU”、“x86”和“x64”。

ProcessorArchitecture

.NET

解析程序集引用时使用的处理器架构。有效值为“msil”、“x86”、“amd64”或“ia64”。

ProduceOnlyReferenceAssembly

.NET

布尔值，指示编译器仅发出引用程序集，而不是已编译代码。不能与 ProduceReferenceAssembly 一起使用。此属性对应于 vbc.exe 和 csc.exe 编译器的 /refonly 开关。

ProduceReferenceAssembly

.NET

一个布尔值，设置为 true 时，可为当前程序集生成引用程序集。使用此功能时，Deterministic 应为 true。此属性对应于 vbc.exe 和 csc.exe 编译器的 /refout 开关。

RegisterAssemblyMSBuildArchitecture

仅限 Windows

指定注册托管 DLL 的默认体系结构。此属性很有用，因为 COM 使用 Windows 注册表将注册存储在特定于体系结构的 Hive 中。例如，在 Windows 系统上，AnyCPU 托管程序集可以在 64 位 Hive 和/或 32 位 (WoW) Hive 中注册其类型，并且生成将使用此属性来确定要使用的特定于体系结构的注册表 Hive。有效值包括“x86”、“x64”和“ARM64”。

RegisterForCOMInterop

仅限 Windows

指示托管应用程序将公开 COM 对象（COM 可调用包装器）。请参阅“生成”页面 - “输出”部分。此设置仅影响正在生成相应项目的计算机。如果要部署到其他计算机，请调用 regasm.exe 以在目标计算机上注册程序集。

RemoveIntegerChecks

Visual Basic

一个布尔值，指示是否禁用整数溢出错误检查。默认值为 false。此属性等效于 vbc.exe 编译器的 /removeintchecks 开关。

RootNamespace

全部

在命名嵌入资源时要使用的根命名空间。此命名空间属于嵌入资源清单名称的一部分。

属性或参数名

项目类型

说明

Satellite_AlgorithmId

.NET

在创建附属程序集时要使用的 AL.exe 哈希算法的 ID。

Satellite_BaseAddress

.NET

在使用 CreateSatelliteAssemblies 目标生成特定于区域性的附属程序集时要使用的基址。

Satellite_CompanyName

.NET

要在附属程序集生成期间传入 AL.exe 的公司名称。

Satellite_Configuration

.NET

要在附属程序集生成期间传入 AL.exe 的配置名称。

Satellite_Description

.NET

要在附属程序集生成期间传入 AL.exe 的说明文本。

Satellite_EvidenceFile

.NET

在具有资源名称“Security.Evidence”的附属程序集中嵌入指定文件。

Satellite_FileVersion

.NET

为附属程序集中的“文件版本”字段指定字符串。

Satellite_Flags

.NET

指定附属程序集中“标志”字段的值。

Satellite_GenerateFullPaths

.NET

使生成任务对错误消息中报告的所有文件使用绝对路径。

Satellite_LinkResource

.NET

将指定的资源文件链接至某个附属程序集。

Satellite_MainEntryPoint

.NET

指定方法的完全限定名称（即 class.method），以用作在附属程序集生成期间将模块转换为可执行文件时的入口点。

Satellite_ProductName

.NET

为附属程序集中的“产品”字段指定字符串。

Satellite_ProductVersion

.NET

为附属程序集中的“ProductVersion”字段指定字符串。

Satellite_TargetType

.NET

将附属程序集输出文件的文件格式指定为“library”、“exe”或“win”。默认值为“library”。

Satellite_Title

.NET

为附属程序集中的“标题”字段指定字符串。

Satellite_Trademark

.NET

为附属程序集中的“商标”字段指定字符串。

Satellite_Version

.NET

指定附属程序集的版本信息。

Satellite_Win32Icon

.NET

在附属程序集中插入一个 .ico 图标文件。

Satellite_Win32Resource

.NET

在附属程序集中插入一个 Win32 资源（.res 文件）。

SGenToolPath

.NET

一个可选的工具路径，指示在当前版本的 SGen.exe 被重写时可以获得 SGen.exe 的位置。

属性或参数名

项目类型

说明

SGenUseProxyTypes

.NET

一个布尔值，指示是否应由 SGen.exe 生成代理类型。这仅适用于 GenerateSerializationAssemblies 设置为开的情况。 SGen 目标使用此属性来设置 UseProxyTypes 标志。此属性默认为 true，并且没有可以更改此属性的 UI。若要生成非 webservice 类型的序列化程序集，请在导入 Microsoft.Common.Targets 或 C#/VB.targets 之前将此属性添加到项目文件并将其设为 false 。

SkipInvalidConfigurations

全部

等于 true 时，会生成对无效平台和配置组合的警告，但不会让生成操作失败；等于 false 或未定义（默认值）时，会生成错误。

StartupObject

.NET

指定包含 Main 方法或 Sub Main 过程的类或模块。此属性等效于 /main 编译器开关。

SubsystemVersion

.NET

指定生成的可执行文件可以使用的子系统的最低版本。此属性等效于 /subsystemversion 编译器开关。有关此属性的默认值的信息，请参阅 /subsystemversion (Visual Basic) 或 /subsystemversion（C# 编译器选项）。

TargetCompactFramework

.NET

运行你所生成的应用程序所需要的 .NET Compact Framework 的版本。通过指定此属性，你可以引用否则将无法引用的某些 Framework 程序集。

TargetFrameworkVersion

.NET

运行你所生成的应用程序所需要的 .NET Framework 的版本。通过指定此属性，你可以引用否则将无法引用的某些 Framework 程序集。

TreatWarningsAsErrors

.NET

一个布尔型参数，如果设置为 true，则会导致将所有警告都视为错误。此参数等效于 /nowarn 编译器开关。

UseCommonOutputDirectory

.NET

想要解决方案中的所有生成输出使用同一输出目录时，可设为 true 的布尔属性。如果为 true，则引用项目的输出不会复制到使用这些依赖项的项目中，就像通常情况下此设置为 false 时一样。将此参数设置为 true 不会更改任何项目的实际输出目录；对于每个需要输出目录的项目，仍需将其设置为所需的公共输出目录。

UseHostCompilerIfAvailable

.NET

一个布尔型参数，如果设置为 true，则会使得生成任务使用进程内编译器对象（如果可用）。此参数仅供 Visual Studio 使用。

Utf8Output

.NET

一个布尔型参数，如果设置为 true，则使用 UTF-8 编码记录编译器输出。此参数等效于 /utf8Output 编译器开关。

属性或参数名

项目类型

说明

VbcToolPath

Visual Basic

一个可选路径，在当前版本的 vbc.exe 被重写时它可以指示 vbc.exe 的另一个位置。

VbcVerbosity

Visual Basic

指定 Visual Basic 编译器输出的详细程度。有效值为“Quiet”、“Normal”（默认值）或“Verbose”。

VisualStudioVersion

全部

指定运行此项目应考虑使用的 Visual Studio 的版本。如果未指定此属性，MSBuild 会将其设置为 {VisualStudioMajorVersion}.0 的默认值；例如，对于所有版本的 Visual Studio 2022，它将是 17.0。此属性在多种项目类型中用于指定要生成的目标组。如果将某个项目的 ToolsVersion 设置为 4.0 或更高版本，则 VisualStudioVersion 将用于指定要使用的子工具集。有关详细信息，请参阅工具集 (ToolsVersion)。

WarningsAsErrors

.NET

指定将被视为错误的警告的列表。此参数等效于 /warnaserror 编译器开关。

WarningLevel

全部

指定要传递给编译器的警告等级，用于编译器发出的警告。此设置不影响没有级别指定的 MSBuild 警告。请参阅 C# 编译器文档中的警告等级和 C++ 编译器文档中的 /W（警告等级）。

WarningsNotAsErrors

.NET

指定不被视为错误的警告的列表。此参数等效于 /warnaserror 编译器开关。

Win32Manifest

.NET

应嵌入最终程序集中的清单文件的名称。此参数等效于 /win32Manifest 编译器开关。

Win32Resource

.NET

要嵌入最终程序集中的 Win32 资源的文件名。此参数等效于 /win32resource 编译器开关。

框架属性中记录了特定于 .NET SDK 项目的属性，例如 TargetFramework。

请参阅

常用的 MSBuild 项目项

通用 MSBuild 项元数据

MSBuild 保留属性和已知属性

.NET SDK 项目的 MSBuild 引用

其他资源

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

其他资源

本文内容

加州消费者隐私法案 (CCPA) 禁用图标

你的隐私选择

主题

亮

暗

高对比度

早期版本

博客

参与

隐私

使用条款

商标

理解 C# 项目 csproj 文件格式的本质和编译流程_csproj build 单独编译一个工程-CSDN博客

理解 C# 项目 csproj 文件格式的本质和编译流程

最新推荐文章于 2023-07-21 21:10:44 发布

sinolover

最新推荐文章于 2023-07-21 21:10:44 发布

阅读量521

点赞数

分类专栏：

# Visualstudio

本文链接：https://blog.csdn.net/sinolover/article/details/104496773

版权

Visualstudio

专栏收录该内容

29 篇文章

1 订阅

订阅专栏

本文将直接从 csproj 文件格式的本质来看以上这些问题。

阅读本文，你将：

可以通读 csproj 文件，并说出其中每一行的含义

可以手工修改 csproj 文件，以实现你希望达到的高级功能（更高级的，可以开始写个工具自动完成这样的工作了）

理解新旧 csproj 文件的差异，不至于写工具解析和修改 csproj 文件的时候出现不兼容的错误

csproj 里面是什么？

一、总览 csproj 文件

相信你一定见过传统的 csproj 文件格式。就算你几乎从来没主动去看过里面的内容，在版本管理工具中解冲突时也在里面修改过内容。

不过，既然这篇文章的目标是理解 csproj 文件格式的本质，那我当然不会把这么复杂的文件内容直接给你去阅读。

我已经将整个文件结构进行了极度简化，然后用思维导图进行了分割。总结成了下图，如果先不关注文件的细节，是不是更容易看懂了呢？

如果你此前也阅读过我的其他博客，会发现我一直在试图推荐使用新的 csproj 格式：

将 WPF、UWP 以及其他各种类型的旧样式的 csproj 文件迁移成新样式的 csproj 文件

让一个 csproj 项目指定多个开发框架

那么新格式和旧格式究竟有哪些不同使得新的格式如此简洁？

于是，我将新的 csproj 文件结构也进行简化，用思维导图进行了分割。总结成了下图：

我把两个思维导图放到一起方便比较：

是什么导致了这样的差异？在了解 csproj 文件中各个部件的作用之前，这似乎很难回答。

二、了解 csproj 中的各个部件的作用

xml 声明部分完全没有在此解释的必要了，为兼容性提供了方便，详见：XML - Wikipedia。

接下来，我们不会依照部件出现的顺序安排描述的顺序，而是按照关注程度排序。

1.PropertyGroup

PropertyGroup 是用来存放属性的地方，这与它的名字非常契合。那么里面放什么属性呢？答案是——什么都能放！

在这里写属性就像在代码中定义属性或变量一样，只要写了，就会生成一个指定名称的属性。

比如，我们写：

walterlv is a 逗比

那么，就会生成一个 Foo 属性，值为字符串 walterlv is a 逗比。至于这个属性有什么用，那就不归这里管了。

从这个角度来说，如果你没有任何地方用到了你定义的属性，那为什么还要定义它呢？是的——这只是浪费。

PropertyGroup 可以定义很多个，里面都可以同等地放属性。至于为什么会定义多个，原因无外乎两个：

为了可读性——将一组相关的属性放在一起，便于阅读和理解意图（旧的 csproj 谈不上什么可读性）

为了加条件——有的属性在 Debug 和 Release 下不一样（例如条件编译符 DefineConstants）

2.ItemGroup

ItemGroup 是用来指定集合的地方，这与它的名字非常契合。那么这集合里面放什么项呢？答案是——什么都能放！

既然什么都能放，那我们放这些吧：

walterlv is a 逗比walterlv is a 天才天才向左，逗比向右逗比属性额外加成

于是我们就有 4 个类型为 Foo 的项了，至于这 4 个 Foo 项有什么作用，那就不归这里管了。

这些项的含义与 PropertyGroup 一样也是由外部来决定。具体是哪个外部，我们稍后会说。但是我们依然有一些常见的项可以先介绍介绍：

ItemGroup 也可以放很多个，一样是为了提升可读性或者增加条件。

3.Import

那么，被我们 Import 进来的那些文件是什么呢？用两种扩展名，定义属性的那一种是 .props，定义行为的那一种是 .targets。

说了这么多，让我们来看其中两个 .props 文件吧。

先看看旧格式 csproj 文件中第一行一定会 Import 的那个 Microsoft.Common.props。

truetruetruetruetrue

文件太长，做了大量删减，但也可以看到文件格式与 csproj 几乎是一样的。此文件中，根据其他属性的值有条件地定义了另一些属性。

此文件中将三个 dll 文件从 MSTest 的 NuGet 包中以链接的形式包含到项目中，并且此文件在 Visual Studio 的解决方案列表中不可见。

可以看出，引入的 props 文件可以实现几乎与 csproj 文件中一样的功能。

4.Target

终于开始说 Target 了。为什么会这么期待呢？因为前面埋下的各种伏笔几乎都要在这一节点得到解释了。

一般来说，Target 节点写在 csproj 文件的末尾，但这个并不是强制的。Targets 是一种非常强大的功能扩展方式，支持 msbuild 预定义的一些指令，支持命令行，甚至支持使用 C# 直接编写（当然编译成 dll 会更方便些），还支持这些的排列组合和顺序安排。而我们实质上的编译过程便全部由这些 Targets 来完成。我们甚至可以直接说——编译过程就是靠这些 Target 的组合来完成的。

不过，为了简单地理解 Target，我依然需要借用官方文档的例子作为开头。

这份代码定义了一个名为 Construct 的 Target，这是随意取的一个名字，并不重要——但是编译过程中会执行这个 Target。在这个 Target 内部，使用了一个 msbuild 自带的名为 Csc 的 Task。这里我们再次引入了一个新的概念 Task。而 Task 是 Target内部真正完成逻辑性任务的核心；或者说 Target 其实只是一种容器，本身并不包含编译逻辑，但它的内部可以存放 Task 来实现编译逻辑。一个 Target 内可以放多个 Task，不止如此，还能放 PropertyGroup 和 ItemGroup，不过这是仅在编译期生效的属性和项了。

于是的含义便是调用 msbuild 内置的 C# 编译器编译所有 Compile 类型的项。

如果后面定义了一个跟此名称一样的 Target，那么后一个 Target 就会覆盖前一个 Target，导致前一个 Target 失效。

再次回到传统的 csproj 文件上来，每一个传统格式的 csproj 都有这样一行：

5.Project

就靠 Project 节点了。

编译器是如何将这些零散的部件组织起来的？

我们前一部分介绍每个部件的时候，已经简单说了其组织方式，这里我们进行一个回顾和总结。

新旧 csproj 在编译过程上有什么差异？

不过好在 NuGet 4.x 以上版本在安装 NuGet 包时自动为我们在 csproj 中插入了以上代码。

原文地址：https://walterlv.github.io/post/understand-the-csproj.html

作者：欲与星辰眠链接：https://www.jianshu.com/p/0ff2a76167fc 来源：简书著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

优惠劵

sinolover

关注

踩

觉得还不错?

一键收藏

知道了

理解 C# 项目 csproj 文件格式的本质和编译流程

写了这么多个 C# 项目，是否对项目文件 csproj 有一些了解呢？Visual Studio 是怎么让 csproj 中的内容正确显示出来的呢？更深入的，我能够自己扩展 csproj 的功能吗？本文将直接从 csproj 文件格式的本质来看以上这些问题。阅读本文，你将：可以通读 csproj 文件，并说出其中每一行的含义可以手工修改 csproj 文件，以实现你希望达到的高级功...

复制链接

扫一扫

专栏目录

获取C#项目包含的所有程序文件的源代码

12-12

获取C#项目包含的所有程序文件的源代码，包含项目文件SLN的解析，解决方案CSPROJ的解析，XML命名空间的适配。

C# 项目，当提示缺少.csproj 文件，如何处理？

YouChuanChiMeng的博客

12-01

1631

C# 项目，当提示缺少.csproj 文件，如何处理？

参与评论

您还未登录，请先

后发表或查看评论

csproj文件常用设置及C#注释常用写法

博客

06-29

774

csproj文件常用设置及C#注释常用写法

ASP.NET 代码找不到 .csproj 文件 ? 因为这是.Net 2.0项目

brook0344的专栏

04-19

2274

直接用2005打开网站，选中有代码那个文件夹就可以了：

c# 在现有项目中添加另一项目中的整个文件夹（多层）的方法（.csproj文件）

lanshahewu的博客

03-16

2706

如题，如下图

右键–《解决方案“lesson5”(1个项目)》–“添加”–“现有项目”，找到项目A的.csproj文件

下一步：

下一步，目标文件夹已添加，如下：

添加项目引用，如下：

最后一步，如下：

确定，万事大吉

...

【CSharp】关于xxx.csproj文件的理解

jn10010537的博客

07-21

592

.csproj 文件

.Csproj文件学习笔记 - N-COUNT - 博客园

会员

周边

新闻

博问

AI培训

云市场

所有博客

当前博客

我的博客

我的园子

账号设置

简洁模式 ...

退出登录

N-COUNT

学习进步

博客园

首页

新随笔

联系

管理

.Csproj文件学习笔记

.csproj是基于XML的格式。以下示例显示了使用.NET Core项目的根节点Microsoft.NET.Sdk。对于Web项目，使用的SDK是Microsoft.NET.Sdk.Web。

我们可以自己直接编辑.csproj文件，并手动添加必要的项目。所需的确切代码取决于需要链接的文件类型以及所需的MSBuild操作类型。

Visual Studio现在使用.csproj文件来管理项目。我们可以通过右键单击项目并选择Edit .csproj来编辑.csproj设置，如下所示。

上面项目的.csproj如下所示。

csproj文件包括与目标.NET Framework，项目文件夹，NuGet程序包引用等相关的设置。

.csproj是基于XML的格式。以下示例显示了使用.NET Core项目的根节点Microsoft.NET.Sdk。对于Web项目，使用的SDK是Microsoft.NET.Sdk.Web。

...

我们可以自己直接编辑.csproj文件，并手动添加必要的项目。所需的确切代码取决于需要链接的文件类型以及所需的MSBuild操作类型。

例如，如果我们要通过链接从项目外部添加.cs文件，则可以使用嵌套在中的元素：

Include给出项目文件夹中文件的相对路径，Link属性告诉MSBuild将文件添加为链接，以及应该用于该文件的名称。甚至还可以更改文件名。

对于诸如JSON配置文件之类的内容文件，我们可以使用元素，例如：

在此示例中，我们将CopyToOutputDirectory设置为PreserveNewest，以便在构建或发布项目时将文件复制到输出目录。

PackageReference元素指定项目的NuGet依赖。Include属性指定包ID

Version属性指定要还原的软件包的版本。

IncludeAssets属性指定应使用属于指定包的哪些资产。默认情况下，包括所有包装资产。

ExcludeAssets属性指定不应消耗属于指定包的资产。

PrivateAssets属性指定应使用属于指定包的哪些资产，但不应流到下一个项目。的Analyzers，Build和ContentFiles资产都默认为私享此属性不存在。

多个目标框架

我们可以创建.NET Core应用程序并为其配置多个目标框架，以便它可以与所有已配置的目标框架一起运行。要定位多个框架，需要更改为复数，并包含我们要定位的不同框架的别名，并用;分隔：

netstandard2.0;net462

条件引用

我们可能会遇到的一个问题是，需要根据要构建的目标引用不同的程序集或NuGet程序包。

例如，我们将以下方法添加到我们的库中，它将成功编译.NET Standard 2.0目标，但是.NET 4.6.2目标将失败，因为它找不到.NET的定义HttpUtility。

public string JavaScriptEncode(string input)

{

return HttpUtility.JavaScriptStringEncode(input);

}

要解决此问题，我们需要添加对System.Web程序集的引用，但仅.NET 4.6.2目标需要它。为此，我们只需.csproj使用以下语法在文件中添加条件引用即可：

如果要有条件引用的NuGet程序包，则使用PackageReference。可以使用多个条件：

条件编译

有时我们可能想从某些目标的编译中排除某些C＃文件。例如，以下是在NAudio中针对.NET 3.5目标的方法，我引用了System.Windows.Forms程序集，并从编译中排除了三个特定文件：

posted @

2020-10-21 01:52

N-COUNT

阅读(2605)

编辑

会员力量，点亮园子希望

刷新页面返回顶部

公告

im钱包App官网最新版下载 数字资产服务平台

imtoken网站|csproj文件

理解C#项目构建配置文件——MSBuild csproj文件 - 知乎

.csproj 文件_csproj是什么文件-CSDN博客

理解 C# 项目 csproj 文件格式的本质和编译流程 - walterlv - 博客园

如何运行 C# 程序 - Visual Studio (Windows) | Microsoft Learn

理解 C# 项目 csproj 文件格式的本质和编译流程_.csproj-CSDN博客

.NET 项目 SDK 概述 | Microsoft Learn

常用的 MSBuild 项目属性 - MSBuild | Microsoft Learn

理解 C# 项目 csproj 文件格式的本质和编译流程_csproj build 单独编译一个工程-CSDN博客

.Csproj文件学习笔记 - N-COUNT - 博客园

im钱包App官网最新版下载
数字资产服务平台