C#方便的生成函数字典
2012-03-29 14:15
155 查看
下面介绍一个方式能够很快的生成对C#函数的注释转成XML文档,这样能够减少很多的函数说明文档的撰写时间,直接进去主题:
有个解决方案下有个XmlHelper.cs 对于XML的通用操作类,下面是部分代码
如果全部代码放出,会发现函数非常多,如果撰写函数说明文档会非常的费时间。所以我们让它们自动生成。
步骤1:点击开始->Microsoft Visual Studio 2008->Visual Studio Tools->Visual Studio 2008 命令提示
步骤2: 输入 csc /t:library /doc:想要输出的名字 cs文件路径 csc /t:library /doc:xmlHelp.xml C:\Users\Sunnes001\Desktop\生成函数字典\生成函数字典\生成函数字典\xmlHelp.cs
步骤3: 回车完成 然后在路径为C:\Program Files\Microsoft Visual Studio 9.0\VC 下就能找到生成的XML可以用浏览器直接打开。
有个解决方案下有个XmlHelper.cs 对于XML的通用操作类,下面是部分代码
/************************************************************************************* * 代码:吴蒋 * 时间:2012.03.07 * 说明:XML操作类 * 其他: * 修改人: * 修改时间: * 修改说明: ************************************************************************************/ #region 引用空间 using System; using System.Collections; using System.Xml; using System.Data; using System.IO; using System.Text; using System.Collections.Generic; #endregion namespace Tools { #region XML操作类 /// <summary> /// XML操作类 /// </summary> public class XmlHelper { #region 构造函数 /// <summary> /// 单例 /// </summary> /// <returns>XmlHelper</returns> public static XmlHelper Instance() { return new XmlHelper(); } #endregion #region 公共变量 /// <summary> /// XML文档对象 /// </summary> XmlDocument xmlDoc; /// <summary> /// XML文档节点 /// </summary> XmlNode xmlNode; /// <summary> /// XML文档元素 /// </summary> XmlElement xmlElem; /// <summary> /// XML节点列表 /// </summary> XmlNodeList xmlNodeList; #endregion #region 分页获取主题配置Jason /// <summary> /// 分页获取主题配置Jason /// </summary> /// <param name="allCount">返回主题总数</param> /// <param name="pageCount">返回主题页数</param> /// <param name="pageSize">一页数量</param> /// <param name="absolutePage">当前页</param> /// <param name="filePath">配置文件路径</param> /// <param name="docPath">节点路径</param> /// <param name="atrList">属性列表</param> /// <returns>返回Jason格式主题数据</returns> public string SelectConfigListJason(out int allCount, out int pageCount, int pageSize, int absolutePage, string filePath, string docPath, List<string> atrList) { xmlDoc = new XmlDocument(); xmlDoc = this.Read(filePath); xmlNodeList = xmlDoc.SelectNodes(docPath); allCount = xmlNodeList.Count; if (allCount % pageSize > 0) { pageCount = allCount / pageSize + 1; } else { pageCount = allCount / pageSize; } int start = pageSize * (absolutePage - 1); int end = start + pageSize - 1; if (allCount > 0) { StringBuilder sb = new StringBuilder(); XmlNode xmlNode = null; for (int i = start; i <= end; i++) { xmlNode = xmlNodeList.Item(i); sb.Append("{"); for (int a = 0; a < atrList.Count; a++) { if (atrList.Count - 1 == a) { sb.Append("\"" + atrList[a] + "\":" + "\"" + xmlNode.Attributes[atrList[a]].InnerText + "\""); } else { sb.Append("\"" + atrList[a] + "\":" + "\"" + xmlNode.Attributes[atrList[a]].InnerText + "\","); } } if (i == end) { sb.Append("}"); } else { sb.Append("},"); } } return sb.ToString(); } else { return ""; } } #endregion }
如果全部代码放出,会发现函数非常多,如果撰写函数说明文档会非常的费时间。所以我们让它们自动生成。
步骤1:点击开始->Microsoft Visual Studio 2008->Visual Studio Tools->Visual Studio 2008 命令提示
步骤2: 输入 csc /t:library /doc:想要输出的名字 cs文件路径 csc /t:library /doc:xmlHelp.xml C:\Users\Sunnes001\Desktop\生成函数字典\生成函数字典\生成函数字典\xmlHelp.cs
步骤3: 回车完成 然后在路径为C:\Program Files\Microsoft Visual Studio 9.0\VC 下就能找到生成的XML可以用浏览器直接打开。
相关文章推荐
- C#方便的生成函数字典
- C# 6 元组应用 Part 1:方便的字典工厂方法
- c#字典
- C#返回在字典或列表中指定的序列中满足条件的元素数量 dictionary.count
- C#中Dictionary(字典)的用法
- C#Json序列化、反序列化之Dictionary 字典类型
- c# Json 自定义类作为字典键时,序列化和反序列化的处理方法
- C# 统计文章中字符的种类和个数 哈希表和字典的使用
- C#中的Dictionary字典类介绍
- C#测试代码、函数、方法执行时间,方便进行系统性能评估
- C# Enum枚举转 Dictionary字典
- C# Enum枚举转 Dictionary字典
- C#中的Dictionary字典类介绍
- C#学习日记 字典
- C#中字典集合HashTable、Dictionary、ConcurrentDictionary三者区别
- GridView的控件说明[字典]-----方便查询
- C#基础知识之使用字典
- 常用工具之 vb转化C# 数据连接串 正则表达式查询 源码世界 脚本字典
- C# 字典排序Array.Sort
- C#.NET微信公众账号接口开发系列文章整理--微信接口开发目录,方便需要的博友查询