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 "";
}
相关推荐
专注仿真3 小时前
CMO模型文档-活动单元基类
c#·模型·cmo·活动单元基类
我是苏苏5 小时前
Agent 开发实战 :C#实现语义检索!向量数据库Qdrant的下载安装及调试步骤
c#·ai编程
光泽雨6 小时前
IEnumerable<T> 详细讲解
c#·c
Lost of 程序猿7 小时前
.NET 10 船端单机部署与离线升级实战:从闪退事故到无感回滚
c#·asp.net·.net
淡海水8 小时前
11-04-Unity-Span-foreach-LINQ的分配与热路径边界
unity·c#·linq·foreach·span
唐青枫21 小时前
对象到底住在哪里?C#.NET 托管堆从分配、GC 到内存排查
c#·.net
fogota1 天前
Emoji与Segoe MDL2 Assets的比较
c#·wpf
灸木1 天前
C# 多线程与异步
c#
鱼听禅1 天前
C# 学习笔记-使用 类型化客户端搭建HTTP客户端服务
学习·http·c#·工厂方法模式
geovindu1 天前
CSharp:Condition Variable Pattern
后端·设计模式·c#·.net·.netcore·条件变量模式·同步型模式