Как читать комментарии к документации по XML с использованием Roslyn

Question

Я хотел был бы иметь возможность прочитать комментарии документации XML во время разбора исходного кода C# с использованием Roslyn.

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

Я попытался установить ParseDocumentationComments в ParseOptions, но это, кажется, не имеют эффекта?

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

Answer 1

Вам нужно либо:

1. Посмотрите на LeadingTrivia синтаксиса, который содержит XML-документ комментарии
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 answer above:

1. Добавить Microsoft.CodeAnalysis.CSharp через NuGet

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); 
       } 
   } 
   

Answer 3

Update:

FirstOrDefault метод больше не доступен. Поэтому вместо этого используйте enumerator.

Обновленный код:

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 enumerator = trivias.GetEnumerator(); 
     while (enumerator.MoveNext()) 
     { 
      var trivia = enumerator.Current; 
      if(trivia.Kind().Equals(SyntaxKind.SingleLineDocumentationCommentTrivia)) 
      { 
       var xml = trivia.GetStructure(); 
       Console.WriteLine(xml); 
      } 
     } 
    } 
}