自动提取C#类文件中的代码注释文字

最新推荐文章于 2025-01-09 10:03:41 发布

原创

最新推荐文章于 2025-01-09 10:03:41 发布 · 3.1k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#c# #string #import #class #xhtml #div

这篇博客展示了如何使用C#从类文件中提取代码注释，包括类、方法和属性的注释。通过遍历指定目录下的.CS文件，提取以'///'开头的多行注释，并格式化输出，便于生成类地图。

<%@ Page Language="C#" AutoEventWireup="true" EnableViewState="false" %>
<%@ Import Namespace="System" %>
<%@ Import Namespace="System.Data" %>
<%@ Import Namespace="System.Configuration" %>
<%@ Import Namespace="System.Web" %>
<%@ Import Namespace="System.Web.Security" %>
<%@ Import Namespace="System.Web.UI" %>
<%@ Import Namespace="System.Web.UI.WebControls" %>
<%@ Import Namespace="System.Web.UI.WebControls.WebParts" %>
<%@ Import Namespace="System.Web.UI.HtmlControls" %>
<%@ Import Namespace="System.Runtime.Remoting" %>
<%@ Import Namespace="System.Runtime.Remoting.Lifetime" %>
<%@ Import Namespace="System.IO" %>
<script language="C#" runat="server">
string Folder = "C_BLL";//需要获取的文件夹
string pContent;

    string KeywordFormat(string inputString)
    {
        string ks = "public,private,static,class,virtual,override,new,void,string,int,bool,double,float,char,byte,DateTime,set,get";
        string[] ka = ks.Split(',');
        string outputString = inputString;
        foreach (string kg in ka)
        {
            outputString = outputString.Replace(kg + " ", "<font class=/"keyword/">" + kg + " </font>");
            outputString = outputString.Replace("(" + kg + ")", "(<font class=/"keyword/">" + kg + "</font>)");
            outputString = outputString.Replace(kg + "[", "<font class=/"keyword/">" + kg + "</font>[");
        }
        return outputString;
    }

    protected void Page_Load(object sender, EventArgs e)
    {
        pContent = "";
        // 用于保存结果
        StringBuilder sb = new StringBuilder();
        // 用于保存注释
        StringBuilder sm = new StringBuilder();

        // 遍历指定目录下的全部 CS 文件
        DirectoryInfo csfile = new DirectoryInfo(Server.MapPath(Folder));
        foreach (System.IO.FileInfo fi in csfile.GetFiles())
        {
            int depth = 0;

sb.AppendLine("<div style=/"padding:4px;margin:10px;padding-left:20px;border:solid 1px #AAAAAA;background-color:#F0F0F0/">");
sb.AppendLine("<font class=/"file/"><b>" + Folder + "/" + fi.Name.ToString() + "</font> ");

            StreamReader TxtReader = new StreamReader(Server.MapPath(Folder + "/" + fi.Name.ToString()), System.Text.Encoding.Default);
            string FileContent = TxtReader.ReadToEnd();
            TxtReader.Close();

// 按行分割
string[] fLines = Regex.Split(FileContent, "/r/n");