类库说明文档生成器

简介:

 原理很简单,解析程序集生成时的xml描述文档。设置生成程序集时生成xml描述文档的操作如下:


程序界面:


生成后的文档视图(样式调整需改源码)


关键代码:

        /// <summary>
        /// 生成HTML说明文档
        /// </summary>
        /// <param name="filePath">文件路径</param>
        public void GenneralHtmlDocument(string filePath)
        {
            XmlDocument doc = new XmlDocument();
            doc.Load(filePath);
            XmlElement root = doc.DocumentElement;
            XmlNodeList nodeList = root.SelectNodes("members")[0].SelectNodes("member");
            XmlNode assembly = root.SelectNodes("assembly")[0].SelectNodes("name")[0];
            StringBuilder htmlBuilder = new StringBuilder();
            htmlBuilder.Append(@"<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.0 Transitional//EN'><html><head><title></title></head><body>");
            htmlBuilder.Append("<table>");
            foreach (XmlNode item in nodeList)
            {
                string name = item.Attributes["name"].InnerText;
                if (name.StartsWith("T"))//类标识
                {
                    string className = name.Substring(name.LastIndexOf(".") + 1);
                    htmlBuilder.Append(string.Format(@" <tr><td colspan='6'> <b>【命名空间:{0}】</b></td></tr>", assembly.InnerText.TrimSpace()));
                    htmlBuilder.Append(string.Format(@" <tr><td colspan='6'> <b>类名:{0}</b></td></tr>", className));
                }
                else if (name.StartsWith("M"))//方法标识
                {
                    string parmsTypeString = string.Empty;
                    string[] parmsTypeArr = new string[] { };
                    if (name.Contains("(") & name.Contains(")"))
                    {
                        parmsTypeString = name.Substring(name.IndexOf("(") + 1, name.LastIndexOf(")") - (name.IndexOf("(") + 1));
                        parmsTypeArr = parmsTypeString.Split(new string[] { "," }, StringSplitOptions.RemoveEmptyEntries);
                    }
                    name = name.Contains("(") ? name.Substring(0, name.LastIndexOf("(")) : name;
                    string methodName = name.Substring(name.LastIndexOf(".") + 1);
                    string methodDescription = item.SelectNodes("summary")[0].InnerText.TrimSpace();
                    htmlBuilder.Append(string.Format(@"<tr><td class='tdleft'>方法名</td><td>{0}</td><td class='tdleft'>方法描述</td><td colspan='2'>{1}</td></tr>", methodName, methodDescription));
                    htmlBuilder.Append("<tr> <td class='tdleft'>参数名称 </td> <td class='tdleft'> 参数类型 </td> <td class='tdleft'> 是否必须 </td><td class='tdleft'>参数描述</td><td class='tdleft'>默认值</td> </tr>");

                    XmlNodeList parmsList = item.SelectNodes("param");
                    for (int i = 0; i < parmsList.Count; i++)
                    {
                        string parmsName = parmsList[i].Attributes["name"].InnerText.TrimSpace();
                        string parmsType = i < parmsTypeArr.Length ? parmsTypeArr[i].TrimSpace() : "";
                        string parmsNotes = parmsList[i].InnerText.TrimSpace();
                        string parmsIsNull = "Null";
                        string parmsDefaultValue = GetTypeDefaultValue(parmsType);
                        htmlBuilder.Append(string.Format("<tr><td>{0}</td><td>{1}</td><td>{2}</td><td>{3}</td><td>{4}</td></tr>",
                              parmsName, parmsType, parmsIsNull, parmsNotes, parmsDefaultValue));
                    }
                    if (item.SelectNodes("returns").Count > 0)
                    {
                        string retrun = item.SelectNodes("returns")[0].InnerText.TrimSpace();
                        htmlBuilder.Append(string.Format("<tr><td  class='tdleft'>返回结果:</td><td colspan='5'>{0}</td></tr>", retrun));
                    }
                    htmlBuilder.Append("<tr><td colspan='6'></td></tr>");
                }
            }
            htmlBuilder = new StringBuilder(htmlBuilder.ToString().Substring(0, htmlBuilder.ToString().Length - "<tr><td colspan='6'></td></tr>".Length));
            htmlBuilder.Append("</table>");
            htmlBuilder.Append("<style type='text/css'>");
            htmlBuilder.Append(".tdleft{  background-color: #F2F5A9;width:10%;}");
            htmlBuilder.Append(".tdvalue{ width:200px;}");
            //表格加边框样式
            htmlBuilder.Append(@"table{border-collapse:collapse;border-spacing:0;border-left:1px solid #888;border-top:1px solid #888;background:#efefef;}th,td{border-right:1px solid #888;border-bottom:1px solid #888;padding:5px 15px;}th{font-weight:bold;background:#ccc;}");
            htmlBuilder.Append("</style>");
            htmlBuilder.Append(@"</body></html>");
            string documentFilePath = Environment.CurrentDirectory + Path.DirectorySeparatorChar + "document.htm";
            SaveStringToFile(documentFilePath, htmlBuilder.ToString());
            ShowFile(documentFilePath);
        }

源码下载: 下载地址


目录
相关文章
|
存储 缓存 5G
时域结构 | 带你读《5G 空口设计与实践进阶 》之十七
在时域,NR 支持基于符号灵活定义的帧结构,以满足各种时延需求。
时域结构 | 带你读《5G 空口设计与实践进阶 》之十七
|
运维 监控 Kubernetes
EDAS助力「人人视频」新业务快速稳健上云
随着疫情袭来,影院全部封闭,然而大家看电影的热情不减,但优质渠道比较少,人人视频敏锐的探察到这个市场需求,结合自身用户量和优质片源的优势,准备推出电影点播业务!
6024 81
EDAS助力「人人视频」新业务快速稳健上云
|
Android开发 Shell
Appium之ADB指令详解
前言 学Android测试,ADB指令是必学的。 图1 一、ADB概述        Android Debug Bridge,Android调试桥接器,简称adb,是用于管理模拟器或真机状态的万能工具,采用了客户端-服务器模型,包括三个部分:        1、客户端部分,运行在开发用的电脑上,可以在命令行中运行adb命令来调用该客户端,像ADB插件和DDMS这样的Android工具也可以调用adb客户端。
1846 0
|
网络协议 网络安全 网络虚拟化
|
Serverless PHP 文件存储
十分钟上线-函数计算玩转 WordPress
众所周知,PHP 是 Web 编程最流行的编程语言,如果有人告诉你,有 Serverless 的 PHP WEB 开发新模式,你是不是会感到好奇和兴奋?本文以部署 WordPress 工程在函数计算环境中为例,向您讲解如何使用阿里云函数计算快速构建或移植基于 PHP 框架开发的 Web, 体验 serverless 开发web 的新姿势。
9332 0
十分钟上线-函数计算玩转 WordPress
|
存储 缓存 NoSQL
阿里云数据库助力利楚扫呗 支撑全国近70万商户聚合支付
客户感言:“依托阿里云丰富的数据库产品能力矩阵,为我们全面助力商户数字化经营转型提供了坚实的保障”——利楚CTO 林喆
1585 0
阿里云数据库助力利楚扫呗 支撑全国近70万商户聚合支付
|
存储 Kubernetes Cloud Native
Argo项目入驻CNCF,一文解析Kubernetes原生工作流
近期CNCF宣布欢迎Argo项目进入 CNCF 孵化器,作为一个新加入的项目,Argo主要关注于Kubernetes原生的工作流,持续部署等方面。 Argo项目是一组Kubernetes原生工具集合,用于运行和管理Kubernetes上的作业和应用程序。
2953 0
|
人工智能 运维 物联网
超低时延 | 带你读《5G承载关键技术与规划设计》之七
通过对 5G 承载需求特性进行综合分析,提出和明确了 5G 承载关键性能、承载组网及功能等需求。相对于 4G 网络,5G 承载呈现出明显的差异化需求。在关键性能方面,本节介绍了在超低时延和高精度同步等需求非常突出;在组网及功能方面,呈现“多层级承载网络、灵活化连接调度、层次化网络切片、智能化协同管控、4G/5G 混合承载以及低成本高速组网”等需求。
超低时延   | 带你读《5G承载关键技术与规划设计》之七
|
定位技术 算法 机器学习/深度学习
高德在提升定位精度方面的探索和实践
阿里巴巴高级地图技术专家方兴在高德技术专场做了题为《向场景化、精细化演进的定位技术》的演讲,主要分享了高德在提升定位精度方面的探索和实践。