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 "";
}
相关推荐
唐青枫4 小时前
别滥用 Task.Run:C# 异步并发实操指南
c#·.net
我好喜欢你~11 小时前
C#---StopWatch类
开发语言·c#
一阵没来由的风14 小时前
拒绝造轮子(C#篇)ZLG CAN卡驱动封装应用
c#·can·封装·zlg·基础封装·轮子
一枚小小程序员哈21 小时前
基于微信小程序的家教服务平台的设计与实现/基于asp.net/c#的家教服务平台/基于asp.net/c#的家教管理系统
后端·c#·asp.net
Eternity_GQM1 天前
【Word VBA Zotero 引用宏错误分析与改正指南】【解决[21–23]参考文献格式插入超链接问题】
开发语言·c#·word
cimeo1 天前
【C 学习】06-算法&程序设计举例
c#
百锦再1 天前
.NET 的 WebApi 项目必要可配置项都有哪些?
java·开发语言·c#·.net·core·net
WYH2872 天前
C#控制台输入(Read()、ReadKey()和ReadLine())
开发语言·c#
hqwest2 天前
C#WPF实战出真汁06--【系统设置】--餐桌类型设置
c#·.net·wpf·布局·分页·命令·viewmodel
做一位快乐的码农2 天前
基于.net、C#、asp.net、vs的保护大自然网站的设计与实现
c#·asp.net·.net