Wie man die Kommentare xml in MrefBuilder (EXE) einfügt

Question

Ich muss die Unterschiede zwischen zwei Baugruppen finden. Die Art und Weise, wie ich das mache, besteht darin, MRefBuilder-generierte XML-Dateien für beide Versionen zu verwenden. Ich verwende C#, um die XML-Dateien zu vergleichen und nur die Methoden, Eigenschaften und Dateien abzurufen, die sich geändert haben. Dann speichere ich das Diff in XML-Datei, und ich erzeuge einen HTML-Bericht mit Hilfe von XSLT

Ich habe eine neue Anforderung; um diese zusätzlichen Kommentare hinzuzufügen

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

in meinem HTML-Bericht. Während diese Kommentare in dem von VisululStudio generierten XML-Bericht enthalten sind, weiß ich nicht, wie sie zu dem vom MRefBuilder erstellten Bericht hinzugefügt werden.

Gibt es eine Möglichkeit-- andere als Code --zu tun?

Answer 1

Die Kurzgeschichte: Wie ich Ihren Workflow sehe, ist es eine Aufgabe Ihres (vorhandenen) C# -Codes, die beiden XML-Dateien der Baugruppen zu vergleichen.

Wie ich verstehe Ihren Workflow:

Baugruppen => MRefBuilder => zwei XML => C# -Code => ein diff.xml => XSLT = HTML

Aber ich bin ein wenig verwirrt darüber, Ihr ... now I got the xml generated by visual studio which has these comments.

Ich habe immer Kommentare in meinen XML-Dokumentationsdateien (!) abhängig von den Inline-Code-Kommentare. Also, wenn Sie einen HTML-Bericht generieren wollen, der von einer diff.xml von XSLT abgeleitet wurde, müssen Sie das natürlich selbst tun.

Ich nehme an, Sie haben Visual Studio installiert und Sandcastle Help File Builder integriert und Sie haben die Option XML-Dokumentationsdatei im Abschnitt Build-Ausgabe überprüft.

BTW - meine Sandcastle Help File Builder Optionen in Visual Studio sind unten dargestellt: