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 "";
}
相关推荐
BruceNeter12 小时前
C# winform卡死问题分析1——线程池子线程创建句柄
c#·.net
何以解忧唯有撸码2 天前
开源】当桌面图标开始打台球:我用 WinForms 做了一桌“真的”台球
c#·winform·自定义控件·gdi
国家一级摸鱼选手2 天前
[Unity]几何碰撞检测:SAT 分离轴定理详解(从数学原理到 C# 实现)
unity·c#·游戏引擎·分离轴定理(sat)·多边形相交
汤姆宝库3 天前
BPE分词器的完整实现:字节对合并与词表构建
开发语言·人工智能·c#
Risehuxyc3 天前
C# 发展历史
开发语言·c#
kyle~3 天前
C# --- 反射
开发语言·c#
暴走约伯4 天前
【VFX工具链源码拆解 09】终极工业化闭环:基于 ID 规则驱动的全自动场景建档、骨骼挂载与男转女场景迁移
unity·c#·游戏引擎·材质
用户788477316345 天前
WinForms 迁移 WPF:Upgrade Assistant 覆盖 30%,剩下 70% 我手写了六周
c#
寂寞的船5 天前
【Unity知识速递】第13期 Unity 内存泄漏排查实战:从 Memory Profiler 到 Lua 引用泄漏的生产级全链路诊断
unity·junit·c#·游戏引擎·lua
用户3721574261356 天前
C# 提取 PDF 附件:包括文档附件和页面注释附件
c#