Как добавить комментарии xml в MrefBuilder (EXE)

Question

Мне нужно найти различия между двумя сборками. Способ, которым я это делаю, заключается в использовании файлов, созданных с помощью MRefBuilder, для обеих версий. Я использую C# для сравнения xml-файлов и получаю только те методы, свойства и файлы, которые были изменены. Затем я сохраняю diff в файле XML, и я генерирую отчет HTML с помощью XSLT

У меня есть новое требование; чтобы добавить дополнительные комментарии

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

в мой HTML-отчет. Хотя эти комментарии включены в отчет XML, созданный с помощью VisaulStudio, я не знаю, как добавить их в отчет, созданный MRefBuilder.

Есть ли способ - кроме кода - для этого?

Answer 1

Краткая история. Поскольку я вижу ваш рабочий процесс, это задача вашего (существующего) кода C#, сравнивающего два xml-файла сборок.

Как я понимаю ваш рабочий процесс:

сборки => MRefBuilder => два XML => ваш C# Code => один diff.xml => XSLT = HTML

Но я немного запутался о ваш ... now I got the xml generated by visual studio which has these comments.

У меня всегда есть комментарии в файлах документации XML (!) в зависимости от встроенных комментариев кода. Итак, если вы хотите сгенерировать HTML-отчет, полученный из diff.xml XSLT, я думаю, вам нужно сделать это самостоятельно.

Я предполагаю, что у вас установлена ​​Visual Studio, а встроенный встроенный редактор файлов Sandcastle интегрирован, и вы проверили параметр файла документации XML в разделе «Вывод сборки».

BTW - мои Sandcastle опции Файл справки Builder внутри Visual Studio приведены ниже: