Menu
Is it possible to generate a set of wiki pages from XML comment file generated by Visual Studio?
I'm talking about something like Sandcastle, but for wiki format instead of compiled CHM.
Edit: I'm using MediaWiki which can import/export articles in XML. So I hope that it is possible to write a transformation converting XML comments to MediaWiki XML.
290
To insert XML comments for a code element Type /// in C#, or ''' in Visual Basic. From the Edit menu, choose IntelliSense > Insert Comment. From the right-click or context menu on or just above the code element, choose Snippet > Insert Comment.
XML comments are usefull for generating documentation. If the code is clearly written then you shouldn't need comments to help you understand the code.
To generate an XML documentation file from documentation comments in the code, use the /doc option with the csc.exe C# compiler. When you build the project, an XML file will be produced by the compiler with a name corresponding to the project name (e.g. XMLDocumentation. dll -> XMLDocumentation.
I'd recommend a bit different solution:
<see href="..."> to link Wiki pages from XML commentsThis is not exactly what you wanted, but I hope this will be helpful.
69
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
