自定义 MSBuild 任务依赖于已编译的代码，但也生成依赖于的代码

Question

我正在尝试生成一个 C# 代码文件，该文件根据 XML 文件构造对象树。 XML 中的元素引用正在编译的项目中定义的类型。生成的代码需要构建在正在编译的项目中找到的类型的对象树。更复杂的是，生成的代码需要编译到正在编译的项目中，并由当前正在编译的项目中的代码引用。

我目前正在尝试使用自定义 MSBuild 任务来执行此操作。该任务将分发给其他开发人员以在他们自己的项目中使用，因此我无法将可用类型硬编码到任务中。

下面是一些示例代码来说明我正在做的事情：

// This is not generated
public class SomeClass {

    public void DoSomething() {}

    public string SomeProperty { get; set; }
}

SomeClass 是在项目中的非生成代码中定义的类型。以下是引用 SomeClass 并填充 SomeProperty 属性的 XML 文件：

... bunch of XML...
<SomeClass SomeProperty="SomeValue" />
... bunch more XML...

SomeOtherClass 有一个未生成的部分声明：

// This is not generated
public partial class SomeOtherClass {

    public void SomeMethod() {
        someField.DoSomething();
    }
}

任务创建一个部分声明SomeOtherClass 声明：

// This is generated
public partial class SomeOtherClass {

    private SomeClass someField = new SomeClass() {
        SomeProperty = "SomeValue"
    };
}

我认为这看起来很像 WPF 对 XAML 文件所做的事情，并且我的用法是相关的（使用 XML 生成实例化对象树的代码，基于同一对象树中的类型）项目是编译）。

解决这个问题的最佳方法是什么？我应该在任务中进行多阶段编译并使用中间文件吗？我是否应该尝试在没有生成代码的情况下在任务中单独构建临时程序集，然后对临时程序集进行反射，然后生成代码文件，然后允许正常的构建过程继续？

Answer 1

这个问题太模糊，无法确定这是否有帮助，但希望这会有所帮助。

1. 确保您的 .props 和 .targets 文件正确

1. 配置 LoadTimeSensitiveTargets 和 LoadTimeSensitiveProperties 以确保 IntelliSense 在项目构建之前就可以正常工作。
   https://github.com/antlr/antlrcs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/AntlrBuildTask/Antlr3.targets#L36-L45

2. 使用 AvailableItemName 属性确保用户可以设置XML 的构建操作文件到您的自定义项目类型。
   https://github.com/antlr/antlrcs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/AntlrBuildTask/Antlr3.targets#L75-L79

3. 如有必要，请使用 ItemDefinitionGroup 元素为具有此自定义项目类型的对象定义默认属性，以减少用户需要执行的工作来配置 XML 文件的构建。
   https://github.com/antlr/antlrcs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/AntlrBuildTask/Antlr3.targets#L81-L88

4. 密切关注方式项目添加到集合中，例如_GenerateCodeFiles，以确保Clean目标正确清理您的构建。

5. 使用 .props 文件指定默认配置元素。当您创建用于分发的 NuGet 包时，.props 文件将包含在用户项目的顶部，而 .targets 将包含在项目底部。

2. 在代码生成过程中不要执行不必要的验证

如果用户犯了错误（例如引用了项目中不存在的项），C# 编译器会通知您。通过在代码生成步骤期间避免这种分析，可以避免问题中描述的循环依赖关系。

3. 禁用或卸载ReSharper

ReSharper 不支持在构建期间生成代码的扩展。尽管上述说明特别遵循了多年来 XAML 支持建立的模式，但您仍将面临以下选择：

1. 保留安装 ReSharper，但不为生成的代码提供 IntelliSense 支持。
2. 卸载 ReSharper，让 Visual Studio 为您的自定义项类型提供与 XAML 文件相同的干净 IntelliSense 体验，从您打开解决方案的第一刻开始。

4. 示例

以下是在构建期间生成代码的两个扩展。

ANTLR 3：
https://github.com/antlr/antlrcs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/AntlrBuildTask/Antlr3.props
https://github.com/antlr/antlrcs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/AntlrBuildTask/Antlr3.targets

ANTLR 4：
https://github.com/tunnelvisionlabs/antlr4cs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/runtime/CSharp/Antlr4BuildTasks/Antlr4.v4.0.props
https://github.com/tunnelvisionlabs/antlr4cs/blob/9ee43ed9486e55afcc1db06f9f0755658974f99f/runtime/CSharp/Antlr4BuildTasks/Antlr4.v4.0.targets