C#使用SyntaxTree获取.cs文件中的属性名和注释

有时候,我们可能需要获取**.cs文件中的属性和对应的注释**来生成一些代码,比如SQL查询什么的。

但使用正则匹配有时候会不准确。搜索了下,发现微软提供了代码解析的API

具体如下两个方法:

cs 复制代码
/// <summary>
/// 获取所有属性和对应的文档注释
/// </summary>
/// <param name="codeContent"></param>
/// <returns></returns>
private Dictionary<string, string> GetPropertyAndItsComment(string codeContent)
{
    Dictionary<string, string> result= new Dictionary<string, string>();
    SyntaxTree tree = CSharpSyntaxTree.ParseText(codeContent);
    CompilationUnitSyntax root = tree.GetCompilationUnitRoot();
    var classDec = (NamespaceDeclarationSyntax)root.Members[0];
    var programDeclaration = (ClassDeclarationSyntax)classDec.Members[0];
    foreach (MemberDeclarationSyntax mem in programDeclaration.Members)
    {
        if (mem is PropertyDeclarationSyntax)
        {
            PropertyDeclarationSyntax pro = (PropertyDeclarationSyntax)mem;
            result.Add(pro.Identifier.Text, GetDocComment(mem));
        }
    }
    return result;
}

/// <summary>
/// 获取注释内容并做处理
/// </summary>
/// <param name="pro"></param>
/// <returns></returns>
private string GetDocComment(MemberDeclarationSyntax pro)
{
    foreach (SyntaxTrivia trivia in pro.GetLeadingTrivia())
    {
        if (trivia.IsKind(SyntaxKind.SingleLineDocumentationCommentTrivia)
            || trivia.IsKind(SyntaxKind.MultiLineDocumentationCommentTrivia)
            )
        {
            string conmment = trivia.ToString().Replace("///","");
            conmment = conmment.Replace("<summary>", "");
            conmment = conmment.Replace("</summary>", "");
            conmment = conmment.Trim();
            return conmment;
        }
    }
    return "";
}
相关推荐
地球驾驶员1 小时前
NX二次开发C#----C#和C++的二次开发程序如何签名?
c#
小码编匠2 小时前
C# 实现网络文件传输:打造稳定可靠的工业级工具
后端·c#·.net
MM_MS3 小时前
SQL Server数据库和Visual Studio (C#)联合编程
开发语言·数据库·sqlserver·c#·visual studio
c#上位机6 小时前
halcon计算区域骨架
图像处理·人工智能·计算机视觉·c#·halcon
曹牧7 小时前
C#:Dictionary类型数组
java·开发语言·c#
GeekyGuru8 小时前
C#:游戏开发的高效利器
开发语言·c#
关关长语8 小时前
基于NCrontab实现Covarel扩展秒级任务调度
c#·.net
足球中国9 小时前
什么情况下会发生跨域
c#·dataexcel·cfucion
yue00810 小时前
C# 实现电脑锁屏功能
开发语言·c#·电脑·电脑锁屏
2501_9307077810 小时前
如何在 C# 中分离饼图的某个区域
开发语言·c#