如何使用Roslyn阅读XML文档注释

Question

我希望能够在使用Roslyn解析C#源代码时阅读XML文档注释.

/// <summary>
/// Documentation...
/// </summary>

我尝试在ParseOptions中设置ParseDocumentationComments,但它似乎没有效果？

var parseOptions = ParseOptions.Default.WithParseDocumentationComments(true);
SyntaxTree unit = SyntaxTree.ParseFile(file, parseOptions);

Answer 1

你需要:

1. 查看LeadingTrivia包含XML doc注释的语法
2. 构造一个Compilation,找到Symbol具有XML doc注释并使用该GetDocumentationComment()方法的方法.

一个完整的例子:

using Roslyn.Compilers.CSharp;
using System;
using System.Linq;

class Program
{
    static void Main(string[] args)
    {
        var tree = SyntaxTree.ParseText(@"
/// <summary>This is an xml doc comment</summary>
class C
{
}");
        var classNode = (ClassDeclarationSyntax)tree.GetRoot().Members.First();
        var trivia = classNode.GetLeadingTrivia().Single(t => t.Kind == SyntaxKind.DocumentationCommentTrivia);
        var xml = trivia.GetStructure();
        Console.WriteLine(xml);

        var compilation = Compilation.Create("test", syntaxTrees: new[] { tree });
        var classSymbol = compilation.GlobalNamespace.GetTypeMembers("C").Single();
        var docComment = classSymbol.GetDocumentationComment();
        Console.WriteLine(docComment.SummaryTextOpt);
    }
}

Answer 2

只是为了更新Kevin Pilch上面的回答:

1. 通过nuget添加Microsoft.CodeAnalysis.CSharp

2. 代码如下:

   using System;
   using System.Linq;
   using Microsoft.CodeAnalysis.CSharp;
   using Microsoft.CodeAnalysis.CSharp.Syntax;
   
   class Program
   {
       static void Main(string[] args)
       {
           var tree = CSharpSyntaxTree.ParseText(@"
   /// <summary> This is an xml doc comment </summary>
   class C
   {
   }");
           var root = (CompilationUnitSyntax) tree.GetRoot();
           var classNode = (ClassDeclarationSyntax) (root.Members.First());
   
           var trivias = classNode.GetLeadingTrivia();
           var xmlCommentTrivia = trivias.FirstOrDefault(t => t.Kind() == SyntaxKind.SingleLineDocumentationCommentTrivia);
           var xml = xmlCommentTrivia.GetStructure();
           Console.WriteLine(xml);
   
           var compilation = CSharpCompilation.Create("test", syntaxTrees: new[] {tree});
           var classSymbol = compilation.GlobalNamespace.GetTypeMembers("C").Single();
           var docComment = classSymbol.GetDocumentationCommentXml();
           Console.WriteLine(docComment);
       }
   }