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 "";
}
相关推荐
小羊没烦恼!2 小时前
系统内部模块(子系统)之间的耦合以及模块(子系统)划分
java·开发语言·前端·数据库·算法·c#
UIU1145 小时前
头文件可以防什么错?运用头文件做声明
c++·学习·c#
鑫 源10 小时前
C#源码开源, 获取macOS 电池数据,包括iOS (xamarin开发)
c#·.net·xamarin
爱吃奥利奥_wen21 小时前
面向对象三板斧:封装、继承、多态,到底在“装“什么、“承“什么、“变“什么?
开发语言·经验分享·c#
wflynn1 天前
GitHub 今日推荐|SCSKiller:游戏着色器预编译消除卡顿
开源·c#·github·nvidia·amd·directx12
疯狂的维修2 天前
关于用C#写电机起保停控制
开发语言·c#
用户788477316342 天前
门店核销闭环:小程序扫码 + .NET 幂等接口 + WPF 看板,一天能跑通
微信小程序·c#
samble2 天前
从零搭建灌装监控系统(十三):报警系统设计,生命周期与通知
c#·wpf·mvvm·modbus·工业控制
miofly2 天前
GitHub 今日推荐|SCSKiller:游戏着色器预编译消除卡顿
开源·c#·github
周杰伦fans3 天前
8GB显存下模型量化实战指南
人工智能·后端·c#