如何在MrefBuilder(EXE)中包含注释xml

时间:2016-07-29 06:47:57

标签: c# xml sandcastle

我需要找到两个组件之间的差异。我这样做的方法是使用MRefBuilder生成的两个版本的xml文件。我使用C#来比较xml文件,并只获取已更改的方法,属性和文件。然后,我将差异保存在XML文件中,并使用XSLT生成HTML报告

我有了新的要求;添加这些额外的评论

<summary>This method does this</summary>
<param name="prm1"></param> 

在我的HTML报告中。 虽然这些评论包含在VisaulStudio生成的XML报告中,但我不知道如何将它们添加到MRefBuilder生成的报告中。

有没有办法 - 除了代码 - 这样做?

1 个答案:

答案 0 :(得分:0)

简短的故事:当我看到您的工作流程时,它(您现有的)C#代码的任务是比较程序集的两个xml文件。

据我了解您的工作流程:

assemblies =&gt; MRefBuilder =&gt;两个XML =&gt;你的C#代码=&gt;一个diff.xml =&gt; XSLT = HTML

但我对你的... now I got the xml generated by visual studio which has these comments.

感到有些困惑

我的XML文档文件(!)中总是有注释,具体取决于内联代码注释。因此,如果您想通过XSLT生成从diff.xml派生的HTML报告,我认为您需要自己完成。

我假设您已安装Visual Studio并集成了Sandcastle帮助文件生成器,并且您在Build Output部分中检查了XML文档文件选项。

enter image description here

BTW - 我在Visual Studio中的Sandcastle帮助文件构建器选项如下所示:

enter image description here