0

我尝试为 Visual Studio 编写一个用于 XML 代码文档的小插件。但是我创建 XML 的代码无法正常工作:

XElement rootElement = new XElement("doc");
XElement summaryElement = new XElement("summary");

var refElement = new XElement("see");
refElement.Add(new XAttribute("cref", codeFunction.Name));
summaryElement.Value = string.Format("Initializes a new instance of the {0} class.", seeRefElement);
rootElement.Add(summaryElement);
comment = rootElement.ToString();

这是输出。

<doc>\r\n  <summary>Initializes a new instance of the &lt;see cref="Form1" /&gt; class.</summary>\r\n</doc>

它应该是:

<doc>\r\n  <summary>Initializes a new instance of the <see cref="Form1" />class.</summary>\r\n</doc>

我应该使用另一种方式来创建我的 XML 吗?任何提示和改进都值得赞赏。

4

3 回答 3

4

替换以下行

summaryElement.Value = string.Format("Initializes a new instance of the {0} class.", refElement);

summaryElement.Add(new XText("Initializes a new instance of the "));
summaryElement.Add(refElement);
summaryElement.Add(new XText(" class."));
于 2012-11-29T00:14:09.267 回答
0

是的,它理所当然地逃避了 < 。其他地方有一个关于此的线程,并提供了一些建议的解决方法:

http://social.msdn.microsoft.com/Forums/en-US/csharplanguage/thread/413654f3-dc2d-4b96-8a7e-bde69da05866

于 2012-11-29T00:05:24.190 回答
0

最简单的方法是使用 Sandcastle 从摘要 XML 生成 API 文档。请参阅此线程以获取链接:是否有任何好的自动化工具来记录 REST API

于 2012-11-29T00:26:25.443 回答