Create Documentation using XML Comments


There is the excellent Sandcastle project that reads in the XML comments from source code and generates help files in a variety of formats. XML Comments also have the benefit of showing up as ToolTips in the Source Code editor of Visual Studio. Having either of these would be of great assistance to someone (like myself) trying to learn how to use the project.


rivantsov wrote Nov 14, 2010 at 4:19 PM

Well, man, I know about these tools.. the problem is - I barely have time to fix bugs, or do enhancements. No time for any documentation. Another problem is that Irony's code keeps changing, formally we're at Alpha state. At BETA (with featureset complete) we can start documenting the code and APIs.

x97mdr wrote Nov 15, 2010 at 4:01 PM

Of course, and I appreciate the effort you are putting in! I only entered them because I was going to take a crack at it myself though (or in case someone else had time). I could at least get the process in place to build the documentation from the XML comments, even if none are there yet. I'll even go through and try to document some of the more important classes as best I can (it would be a good way to learn!).

vermorel wrote Oct 10, 2013 at 12:50 PM

Without getting as far as building a documentation from Sandcastle, just adding a few dozens of XML comments on well-targeted objects (AstNode, Parser, Grammer, NonTerminal, etc) would already be very helpful just through VS Intellisense.