zoukankan
html css js c++ java
类库说明文档生成器
原理很简单,解析程序集生成时的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;10%;}"); htmlBuilder.Append(".tdvalue{ 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); }
源码下载:
下载地址
查看全文
相关阅读:
前端React 条件渲染
hbuilder小白干货之快捷键大全
前端React 元素渲染
mybatis学习笔记五(映射)
mybatis学习笔记四(配置文件)
mybatis学习笔记二(sqlsession与开发dao)
mybatis学习笔记三(动态sql)
mybatis学习笔记一(mybatis概述)
必备idea 插件plugins 提高编码效率
shell提升篇
原文地址:https://www.cnblogs.com/zhangqs008/p/2498391.html
最新文章
Activity调用静态方法改变UI,使用Handler来改变UI显示
mono for android中使用dapper或petapoco对sqlite进行数据操作
查看当前正在运行的activity
从原生APK反编译,拿到界面,用于mono for android
浅谈服务治理、微服务与Service Mesh(三) Service Mesh与Serverless
什么是CPU load
深入浅出Java并发包—CountDownLauch原理分析 (转载)
天天都用消息队列,却不知道为啥要用MQ,这就有点尴尬了
HBuilderX 连接电脑的模拟器问题
原生Android 注意事项
热门文章
ES6
Oracle入门知识
Spring详解
Spring MVC框架理解
Linux的常识
MySQL运用
ScrollView
react-native-router-flux
SQLserver与MySQL的区别(数据库小白须知!!!)
前端React JSX
Copyright © 2011-2022 走看看