Getting started with the Live Documenter

The Live Documenter is a .NET documentation viewer. It opens up the information stored in all of those XML tags and makes them available, quickly. Here is a little introduction to help get your documentation displayed in the Live Documenter. Solutions, projects and libraries To start you just simply need to point the application at a Visual Studio solution or project file. Or if you want to only view the documentation associated with a single library you can do that too. After a couple of fleeting seconds the application will show you all of the compiled libraries you have selected. The colour of the names of the assemblies let you know if there is documentation linked to them; black text means the comments have been found and loaded, grey means that no documentation has been found. This is generally because the XML comment file has not been output by the compiler. Make Visual Studio output your code comments Visual Studio has a property setting that informs the compiler it should output the XML code documentation as part of the build process. If you do not have this set you will find that there are no comments for any of your libraries. You will need to set the property for each of the projects in your solution. For each project, right click the project and select properties. In the properties window select build and at the bottom (seen below) is the check box. Check it, save, recompile and you have output your comments. .NET XML comments The Live Documenter supports all of the .NET XML documentation comments here is a...

Twitter

You can now follow The Box Software on Twitter. Keep up to date with the whats going on with the Live Documenter and let us know what you think of our software....

Live Documenter v1 Release

Exciting times! We are pleased to announce that the first version of the Live Documenter has been released. The Live Documenter is The Box Software’s .NET documentation tool. Giving you live, up to date, access to your .NET XML comments. Grab your copy by simply entering your email and clicking “Get it!”. For more information you can visit out the Live Document page. We hope you love it as much as we do! Download your FREE* copy. Email We hate spam too, and will not pass on your email address. * free for non commercial...