c# – 从MetadataReference中获取ISymbol的文档

2019-06-28 01:02:54 阅读：399 来源： 互联网

标签：c roslyn analysis roslyn-code-analysis

我最近开始学习Roslyn Code Analysis.我经历了提供的示例代码.我的问题如下：

有没有办法如何获取从引用的库加载的符号的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,因此返回空字符串.

UPDATE

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

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

其中TestDocumentationProvider实现了Microsoft.CodeAnalysis DocumentationProvider抽象类.

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

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

解决方法:

更新：在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中使用了类似的东西.

标签：c,roslyn,analysis,roslyn-code-analysis
来源： https://codeday.me/bug/20190628/1310611.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

c# – 从MetadataReference中获取ISymbol的文档