C#: Visual Studio XML-Dokumentation parsen – Update

Ich habe mich noch mal an die Klasse gesetzt und sie um die Methode „Get_MemberText“ erweitert, welche den String in der Spalte „text“ der DataTable anhand eines Übergebenen Typ-Enums und dem Membernamen zurück gibt.

Damit kann man nun folgenes anstellen:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
namespace Test
{
    public partial class Form1 : Form
    {
        STools.xmldoc xmldoc;
 
        public Form1()
        {
            InitializeComponent();
            xmldoc = new STools.xmldoc(@"tADB.xml");
        }
        private void button1_Click(object sender, EventArgs e)
        {
           string methode_intern = "M:taDB.mysql.sql(System.String)";
           Console.Writeline(xmldoc.Get_MemberText(STools.xmldoc.typ.member, methode_intern));
        }
    }
}

Nachfolgend noch einmal der Komplette Code der Klasse incl. Update.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
using System;
using System.Collections.Generic;
using System.Text;
using System.Data;
using System.Xml;
 
namespace STools
{
    class xmldoc
    {
 
        /// <summary>
        /// Klassen-Weites XmlDocument, wird über Ctor gefüllt.
        /// </summary>
        private XmlDocument XMLDoc;
 
        /// <summary>
        /// Klassen-Weite DataTable, wird über Ctor gefüllt.
        /// </summary>
        private DataTable DT_XMLDOC;
 
        /// <summary>
        /// Konstruktor der Klasse.
        /// </summary>
        /// <param name="XMLPfad">Der Pfad zur VS-XML-Dokumentation-Datei.</param>
        public xmldoc(string XMLPfad)
        {
            XMLDoc = new XmlDocument();
            XMLDoc.Load(XMLPfad);
            DT_XMLDOC = XMLDoc2DataTable();
        }
 
        /// <summary>
        /// Enum, der den Member-Typ angibt
        /// </summary>
        public enum typ { 
            member,
            param,
            retruns,
        }
 
        /// <summary>
        /// Erstellt eine DataTable aus der im Ctor übergebenen XML-Datei.
        /// </summary>
        /// <returns>Eine DataTable mit der Klassen-Dokumentation als Inhalt</returns>
        internal DataTable XMLDoc2DataTable()
        {
            DataTable dt_xmldoc = new DataTable("xml_doc");
            dt_xmldoc.Columns.Add("typ");
            dt_xmldoc.Columns.Add("member");
            dt_xmldoc.Columns.Add("name");
            dt_xmldoc.Columns.Add("text");
 
            foreach (XmlElement xmlElement in XMLDoc["doc"]["members"])
            {
                DataRow dr_xmldoc = dt_xmldoc.NewRow();
                dr_xmldoc["typ"] = "member";
                dr_xmldoc["member"] = xmlElement.Attributes["name"].Value.Trim();
                dr_xmldoc["name"] = xmlElement.Attributes["name"].Value.Trim();
                dr_xmldoc["text"] = CleanText(xmlElement.ChildNodes[0].InnerText);
                dt_xmldoc.Rows.Add(dr_xmldoc);
 
                for (int i = 1; i < xmlElement.ChildNodes.Count; i++)
                {
                    dr_xmldoc = dt_xmldoc.NewRow();
                    dr_xmldoc["typ"] = xmlElement.ChildNodes[i].Name.Trim();
                    dr_xmldoc["member"] = xmlElement.Attributes["name"].Value.Trim();
                    if (xmlElement.ChildNodes[i].Attributes["name"] != null)
                    {
                        dr_xmldoc["name"] = xmlElement.ChildNodes[i].Attributes["name"].Value.Trim();
                    }
                    dr_xmldoc["text"] = CleanText(xmlElement.ChildNodes[i].InnerText);
                    dt_xmldoc.Rows.Add(dr_xmldoc);
                }
            }
 
            return dt_xmldoc;
        }
 
 
        /// <summary>
        /// Entfernt Leerzeichen aus den Zeilen des Übergebenen Textes.
        /// </summary>
        /// <param name="text">Ein Text.</param>
        /// <returns>Ein ext ohne Leerzeichen.</returns>
        private string CleanText(string text)
        {
            string neutext = "";
            foreach (string zeile in text.Split(new Char[] { '\n' }))
            {
                neutext = neutext + zeile.Trim() + Environment.NewLine;
            }
            return neutext;
        }
 
        /// <summary>
        /// Gibt den Text aus der XML-Dokumentation anhand des Typ-Enums und dem Member-Namen zurück.
        /// </summary>
        /// <param name="typ">Enum typ</param>
        /// <param name="membername">Der Name des Members</param>
        /// <returns>Ein ext ohne Leerzeichen.</returns>
        internal string Get_MemberText(typ typ, string membername)
        {
            DataRow[] dr_xmldoc = DT_XMLDOC.Select("typ='" + typ.ToString() + "' AND member='" + membername + "'");
            string xmltext = "";
            if (dr_xmldoc.Length > 0)
            {
                xmltext = dr_xmldoc[0]["text"].ToString().Trim();
            }
 
            return xmltext;
        }
    }
}

leave your comment

*

Unterstütze den Frickelblog!