Menu
I just discover I can generate XML documentation for my project with VisualStudio 2010 with the '///' tags in the code.. It's seems magical but what can I do with that? Is some application exists who can make me a "beautiful doc" with the XML file? Or convert it into a HTML doc?
Thanks a lot for all responses!
668
Once you have finished adding data to an XML document, you need to close it. close(); The close method of the XMLDocument class takes no parameters.
An XML document is a basic unit of XML information composed of elements and other markup in an orderly package. An XML document can contains wide variety of data. For example, database of numbers, numbers representing molecular structure or a mathematical equation.
The C# compiler combines the structure of the C# code with the text of the comments into a single XML document. The C# compiler verifies that the comments match the API signatures for relevant tags. Tools that process the XML documentation files can define XML elements and attributes specific to those tools.
To insert XML comments for a code element Type /// in C#, or ''' in Visual Basic.
There are several apps out there that can take your XML Comments and generate MSDN Style API docs for you (working on the list):
Sandcastle (Microsoft)
NDoc
Live Documenter
75
There's an alternative tool DocFX developed by Microsoft.
It generates API doc in HTML format like this.
22
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
