正在从MetadataReference获取ISymbol的文档

本文关键字：ISymbol 文档 获取 MetadataReference | 更新日期: 2023-09-27 17:58:19

我最近开始学习Roslyn代码分析。我浏览了提供的示例代码。我的问题如下：

有没有一种方法可以从引用库中获取符号的XML文档注释

我使用的示例代码是FAQ(7)。目标是获得Console.Write函数的文档注释。

    public void GetWriteXmlComment()
    {
        var project1Id = ProjectId.CreateNewId();
        var document1Id = DocumentId.CreateNewId(project1Id);
        var mscorlib = MetadataReference.CreateFromFile(typeof(object).Assembly.Location);
        var solution = new AdhocWorkspace().CurrentSolution
            .AddProject(project1Id, "Project1", "Project1", LanguageNames.CSharp)
            .AddMetadataReference(project1Id, mscorlib);
        var declarations = SymbolFinder.FindDeclarationsAsync(solution.Projects.First(), "Write", true).Result;
        var decFirst = declarations.First();
        var commentXml = decFirst.GetDocumentationCommentXml();
    }

示例代码适用于某些方法——它可以获得文档文本。但对于方法，如Console.Write，它使用NullDocumentationProvider，因此返回空字符串。

更新

我发现我可以用TestDocumentationProvider实例加载MetadataReference，如下所示：

        var mscorlib = MetadataReference.CreateFromFile(typeof(object).Assembly.Location,
            default(MetadataReferenceProperties), new TestDocumentationProvider());

其中CCD_ 7实现CCD_。

    private class TestDocumentationProvider : DocumentationProvider
    {
        protected override string GetDocumentationForSymbol(string documentationMemberID, CultureInfo preferredCulture, CancellationToken cancellationToken = default(CancellationToken))
        {
            // To-Be-Done
        }
    }

现在问题缩小到如何使用documentationMemberID阅读文档？

正在从MetadataReference获取ISymbol的文档

更新：在Roslyn 2.0中，您可以使用XmlDocumentationProvider.CreateFromFile。

我能想到的唯一方法是使用Reflection创建FileBasedXmlDocumentationProvider（或者从GitHub复制其实现）。您还需要搜索引用程序集，因为框架程序集的加载位置不包含文档。

private static MetadataReference FromType(Type type)
{
    var path = type.Assembly.Location;
    return MetadataReference.CreateFromFile(path, documentation: GetDocumentationProvider(path));
}
private static string GetReferenceAssembliesPath()
{
    var programFiles =
        Environment.GetFolderPath(Environment.Is64BitOperatingSystem
            ? Environment.SpecialFolder.ProgramFilesX86
            : Environment.SpecialFolder.ProgramFiles);
    var path = Path.Combine(programFiles, @"Reference Assemblies'Microsoft'Framework'.NETFramework");
    if (Directory.Exists(path))
    {
        var directories = Directory.EnumerateDirectories(path).OrderByDescending(Path.GetFileName);
        return directories.FirstOrDefault();
    }
    return null;
}
private static DocumentationProvider GetDocumentationProvider(string location)
{
    var referenceLocation = Path.ChangeExtension(location, "xml");
    if (File.Exists(referenceLocation))
    {
        return GetXmlDocumentationProvider(referenceLocation);
    }
    var referenceAssembliesPath = GetReferenceAssembliesPath();
    if (referenceAssembliesPath != null)
    {
        var fileName = Path.GetFileName(location);
        referenceLocation = Path.ChangeExtension(Path.Combine(referenceAssembliesPath, fileName), "xml");
        if (File.Exists(referenceLocation))
        {
            return GetXmlDocumentationProvider(referenceLocation);
        }
    }
    return null;
}
private static DocumentationProvider GetXmlDocumentationProvider(string location)
{
    return (DocumentationProvider)Activator.CreateInstance(Type.GetType(
        "Microsoft.CodeAnalysis.FileBasedXmlDocumentationProvider, Microsoft.CodeAnalysis.Workspaces.Desktop"),
        location);
}

我在RoslynPad中使用过类似的东西。

相关文章：