如何插入VS XML注释代码

。C# 允许开发人员在源代码中插入VS XML注释，这在多人协作开发的时候显得特别有用。 C#分析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。 这篇文章将展示如何 运用这些VS XML注释。作者演示了如何 生成工程，如何 把VS XML注释输出为有用文档，如何 把这些注释转变为帮助文件。 在项目开发中，很多人并不乐意写繁杂的文档。但是，开发组长希望代码注释尽可能细致；项目筹划人员希望代码设计文档尽可能详尽；测试、检查人员希望功能说明书尽可能细致等等。 假如这些文档都被要求写的话，保持它们同步比实行一个战役还痛苦。 为何不把这些信息保存在一个地点呢？？最明显想到的地点就是代码的注释中；但是你很难通览程序，并且有些须要这些文档的人并不懂编码。这篇文章将展示如何 通过运用 VS XML注释来处理这些疑问。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从VS XML注释中取得。我将先演示如何 插入XML注释、如何 把这些XML注释导出为另一个文档。然后再讨论每个XML标记的意思，以及运用 XML和XSL生成帮助文件。所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释，编译器将忽略后面的内容。三条斜线告诉编译器，后面是VS XML注释，须要适当地处理。当开发人员输入三个向前的斜线后，Microsoft Visual Studio .NET IDE 自动检查它能不能在类或者类成员的解释的前面。假如是的话，Visual Studio .NET IDE 将自动插入注释标记，开发人员只须要添加些额外的标记和值。下面就是在成员函数前添加三个斜线，自动添加的注释。

对xml数据进行增,删,改编写XML文件（bookstore.xml）如下： <?xml version="1.0" encoding="gb2312"?><bookstore><book genre="fantasy" ISBN="2-3631-4"><title>Oberon's Legacy</title><author>Corets, Eva</author><price>5.95</price></book></bookstore>1、往<bookstore>节点中插入一个<book>节点： XmlDocument xmlDoc=new XmlDocument()xmlDoc.Load("bookstore.xml")XmlNode root=xmlDoc.SelectSingleNode("bookstore")//查找<bookstore>XmlElement xe1=xmlDoc.CreateElement("book")//创建一个<book>节点 xe1.SetAttribute("genre","小郭")//设置该节点genre属性 xe1.SetAttribute("ISBN","2-3631-4")//设置该节点ISBN属性 XmlElement xesub1=xmlDoc.CreateElement("title")xesub1.InnerText="CS从入门到精通"//设置文本节点 xe1.AppendChild(xesub1)//添加到<book>节点中 XmlElement xesub2=xmlDoc.CreateElement("author")xesub2.InnerText="候捷"xe1.AppendChild(xesub2)XmlElement xesub3=xmlDoc.CreateElement("price")xesub3.InnerText="58.3"xe1.AppendChild(xesub3)root.AppendChild(xe1)//添加到<bookstore>节点中 xmlDoc.Save("bookstore.xml")//================ 结果为： <?xml version="1.0" encoding="gb2312"?><bookstore><book genre="fantasy" ISBN="2-3631-4"><title>Oberon's Legacy</title><author>Corets, Eva</author><price>5.95</price></book><book genre="小郭" ISBN="2-3631-4"><title>CS从入门到精通</title><author>候捷</author><price>58.3</price></book></bookstore> 2、修改节点：将genre属性值为“小郭“的节点的genre值改为“update小郭”，将该节点的子节点<author>的文本修改为“亚胜”。 XmlNodeList nodeList=xmlDoc.SelectSingleNode("bookstore").ChildNodes//获取bookstore节点的所有子节点 foreach(XmlNode xn in nodeList)//遍历所有子节点 { XmlElement xe=(XmlElement)xn//将子节点类型转换为XmlElement类型 if(xe.GetAttribute("genre")=="小郭")//如果genre属性值为“小郭” { xe.SetAttribute("genre","update小郭")//则修改该属性为“update小郭” XmlNodeList nls=xe.ChildNodes//继续获取xe子节点的所有子节点 foreach(XmlNode xn1 in nls)//遍历 { XmlElement xe2=(XmlElement)xn1//转换类型 if(xe2.Name=="author")//如果找到 { xe2.InnerText="亚胜"//则修改 break//找到退出来就可以了 } } break} } xmlDoc.Save("bookstore.xml")//保存。 //================= 最后结果为： <?xml version="1.0" encoding="gb2312"?><bookstore><book genre="fantasy" ISBN="2-3631-4"><title>Oberon's Legacy</title><author>Corets, Eva</author><price>5.95</price></book><book genre="update小郭" ISBN="2-3631-4"><title>CS从入门到精通</title><author>亚胜</author><price>58.3</price></book></bookstore> 3、删除 <book genre="fantasy" ISBN="2-3631-4">节点的genre属性，删除 <book genre="update小郭" ISBN="2-3631-4">节点。 XmlNodeList xnl=xmlDoc.SelectSingleNode("bookstore").ChildNodesforeach(XmlNode xn in xnl) { XmlElement xe=(XmlElement)xnif(xe.GetAttribute("genre")=="fantasy") { xe.RemoveAttribute("genre")//删除genre属性 } else if(xe.GetAttribute("genre")=="update小郭") { xe.RemoveAll()//删除该节点的全部内容 } } xmlDoc.Save("bookstore.xml") //==================== 最后结果为： <?xml version="1.0" encoding="gb2312"?><bookstore><book ISBN="2-3631-4"><title>Oberon's Legacy</title><author>Corets, Eva</author><price>5.95</price></book><book></book></bookstore>4、显示所有数据。 XmlNode xn=xmlDoc.SelectSingleNode("bookstore")XmlNodeList xnl=xn.ChildNodesforeach(XmlNode xnf in xnl) { XmlElement xe=(XmlElement)xnfConsole.WriteLine(xe.GetAttribute("genre"))//显示属性值 Console.WriteLine(xe.GetAttribute("ISBN"))XmlNodeList xnf1=xe.ChildNodesforeach(XmlNode xn2 in xnf1) { Console.WriteLine(xn2.InnerText)//显示子节点点文本 } }

麻烦采纳，谢谢!

---