C#方便的生成函数字典

来源：互联网发布：淘宝无线手焦4 编辑：程序博客网时间：2024/06/08 20:09

C#方便的生成函数字典

下面介绍一个方式能够很快的生成对C#函数的注释转成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;#endregionnamespace 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可以用浏览器直接打开。