在IIncrementalGenerator中获取ProjectReference类的DeclaringSyntaxReference

我来帮你捋清楚这个问题~

首先你遇到的情况是完全正常的：引用项目（比如SomeLib里的ClassInLib）的DeclaringSyntaxReference为空，是因为这些类是从元数据（编译后的DLL）加载的，而非当前编译过程中的源代码。源生成器处理SourceGenTest项目时，只能访问当前项目的语法树，引用库的源代码语法树不会被包含在当前编译的Compilation对象里，自然拿不到语法引用。

但要实现你想要的——获取类、属性的XML注释和默认值——根本不需要依赖DeclaringSyntaxReference，有更直接的解决办法：

1. 获取XML注释：用ISymbol.GetDocumentationCommentXml() #

这个方法专门用来从符号（不管是源代码里的还是元数据里的）提取XML注释，只要引用的库生成了XML文档文件（项目设置里要开启），就能直接拿到注释内容。

2. 获取属性默认值：用IPropertySymbol.ConstantValue #

对于元数据中的属性符号，直接检查HasConstantValue属性，再访问ConstantValue就能拿到默认值，完全不需要语法节点。

修改后的源生成器示例 #

我调整了你的代码，用这些方法来获取你需要的信息：

public class XmlCommentIncrementalGenerator : IIncrementalGenerator
{
    public void Initialize(IncrementalGeneratorInitializationContext context)
    {
        var members = context.CompilationProvider
            .Select((compilation, _) => {
                var typeInfos = compilation.GlobalNamespace.GetNamespaceMembers()
                    .Where(x => x.Name.Contains("SourceGenTest") || x.Name.Contains("SomeLib"))
                    .SelectMany(x => x.GetMembers().OfType<INamedTypeSymbol>())
                    .Select(type => {
                        // 获取类型的XML注释
                        string typeComment = type.GetDocumentationCommentXml().Trim();
                        // 标记语法引用状态
                        string dsrStatus = type.DeclaringSyntaxReferences.Any() 
                            ? $"DSR存在: {type.DeclaringSyntaxReferences.First()}" 
                            : "无DSR（来自元数据）";
                        
                        // 提取属性的默认值与注释
                        var propertyDetails = type.GetMembers()
                            .OfType<IPropertySymbol>()
                            .Select(prop => {
                                string propComment = prop.GetDocumentationCommentXml().Trim();
                                string defaultValue = prop.HasConstantValue 
                                    ? prop.ConstantValue?.ToString() ?? "null" 
                                    : "无默认值";
                                return $"  - {prop.Name}: 默认值={defaultValue}, 注释={propComment}";
                            });

                        return $"{type.Name} [{dsrStatus}]\n// 类型注释: {typeComment}\n// 属性信息:\n{string.Join("\n// ", propertyDetails)}";
                    });

                return typeInfos.ToImmutableArray();
            });

        context.RegisterSourceOutput(members, (ctx, array) => {
            string output = "// 源生成器输出:\n//" + string.Join("\n//", array);
            ctx.AddSource("Output.g.cs", SourceText.From(output, Encoding.UTF8));
        });
    }
}

关键注意点 #

要让引用库的XML注释能被读取到，你需要在SomeLib的项目设置中开启生成XML文档文件：

• 右键SomeLib项目 → 属性 → 生成 → 勾选“生成XML文档文件”
• 这样编译SomeLib时会生成对应的.xml文件，源生成器就能通过GetDocumentationCommentXml()拿到注释内容。

关于“能不能拿到引用项目的DeclaringSyntaxReference” #

如果你的需求真的必须访问引用项目的语法节点（而非仅注释和默认值），那只有一种极端情况能实现：引用的项目是项目引用（不是DLL引用），且源生成器能直接访问到该项目的源代码。但这种场景非常受限，因为源生成器是在当前项目的编译阶段运行的，引用项目此时已经编译完成，语法树不会被包含进来。所以几乎所有场景下，都推荐用元数据符号的方法来获取信息，而非依赖语法引用。

备注：内容来源于stack exchange，提问作者Alamakanambra