C#方便的生成函数字典

原创 2012年03月29日 14:03:01

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;
#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#)之字典的工作原理

字典的使用非常方便,但这里有一个问题:Hashtable(和其它字典类)使用某种算法,根据键来确定每个对象的位置,实际上,该算法并不完全是由Hashtable提供的.它有两个部分,其中一部分的代码必须...
  • hontao2128
  • hontao2128
  • 2007年09月05日 14:54
  • 2580

C#中Dictionary字典取值

// Create a new dictionary of strings, with string keys. // Dictionarystring, string>...
  • u010026901
  • u010026901
  • 2014年03月18日 13:16
  • 3449

C#基础知识之使用字典

using System; using System.Collections.Generic; using System.Linq; using System.Text;namespace UseDi...
  • chongshangyunxiao321
  • chongshangyunxiao321
  • 2016年04月21日 14:49
  • 1222

C#高级编程五十三天----字典Dictionary<TKey,TValue>

字典 关键字:Dicitionary   说明: 必须包含命名空间System.Collection.Generic Dictionary里面的每一个元素都是一个键值对(由两个元组组成:键和...
  • shanyongxu
  • shanyongxu
  • 2015年07月24日 00:25
  • 4012

【C#】C#委托和字典的结合使用

using System.Collections; using System.Collections.Generic; using UnityEngine; public class Delegat...
  • ldy597321444
  • ldy597321444
  • 2017年04月12日 17:45
  • 782

C#字典中使用第一个值的方法

首先要using System.Linq;此处是重点 然后再 new Dictionary(){{}}.First().value
  • xxxwuyufan
  • xxxwuyufan
  • 2018年01月05日 10:03
  • 139

c#字典中传入结构体和类在赋值时候的区别

//我以为这里可以和c++中的map一样,可以直接赋值,但是会报错             //data[i].a = 10;  //这里不能这样直接赋值             //然后我是这么...
  • lxd1207798
  • lxd1207798
  • 2014年10月26日 20:30
  • 464

C#中字典的使用Dictionary

using System;using System.Collections.Generic;using System.Linq;using System.Text;namespace 集合{    c...
  • aladdinty
  • aladdinty
  • 2008年12月23日 22:46
  • 17889

C#字典的遍历方法

命名空间:  System.Collections.Generic Dictionary 类 KeyValuePair 结构 用指定的键和值初始化 KeyValuePair 结构的新...
  • fucun1984686003
  • fucun1984686003
  • 2015年07月20日 15:37
  • 840

C#使用资源字典

1、创建资源字典 点击新建,“添加资源字典”,创建资源字典文件。 2、添加资源 将所用的资源代码加入资源字典文件。                                 ...
  • Zhangchen9091
  • Zhangchen9091
  • 2015年06月11日 22:22
  • 959
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:C#方便的生成函数字典
举报原因:
原因补充:

(最多只允许输入30个字)