XML doc tool

[escristian]

Here is the scenario I have. We want to take the .xml file that is
generated by Visual Studio, send it out to our documentation
department and have them comment on this.

After that we want to be able to take that .xml file, have some kind
of tool that will read the xml file and incorporate it back into the
code. So as to not force us to do this by hand every time
documentation changes something in the generated reference guide.

Has anyone ever heard of a tool like this?

 

[Morten Wennevik [C# MVP]]

Hi,

You need to clarify a bit. What kind of xml file? Visual Studio generates
solution and project files in xml format. Or when you create a web
reference. There are several tools that can generate code based on xml, for
instance xsd.exe

http://msdn.microsoft.com/en-us/library/x6c1kb0s.aspx

 

[escristian]

Ok the .xml file I'm talking about is the documentation .xml file that
is generated from a C# project that when you tick the "XML
documentation file" option in project properties->build tab.

Basically the tool would have to compare the revised xml doc file with
a baseline we would keep, and commit these changes to the source code.
I could write one but I'm guessing we're not the first company to have
this problem.

Thanks

 

[Morten Wennevik [C# MVP]]

Hi,

I'm afraid I am unaware of any tool that would adjust the code based on a
revised documentation. I'm not sure you could gain much from it either,
other than possibly name changes and new or removed method. The
documentation does not display the implementation. If the goal is to do a
kind of peer review of the code base, a UML document might be more
appropriate.