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...

Always live, always up-to-date

Generated documentation has always been static, it get’s created as part of a build, then sits there getting out of date. That’s all well and good when you have released an API which won’t change until your next release. But shouldn’t all those comments work a little harder for you? We believe that if you make the documentation in projects more visible and useful, the documentation will be kept up to date and rich. The Live Documenter does this. Quickly showing nicely laid out documentation on working projects, what’s more, when the project is rebuilt Live Documenter notices this and shows the latest information.     Keep it open while developing and enjoy the fruits of your commenting labour. Working on a new project? Trawling through code and comments when you jump on board with an existing project can be a difficult task. Live Documenter makes it easier by providing this live view of the documentation and quick searching through the entire project. Find the information you need right away.     Here are two reasons why Live Documenter is the tool for you. We will provide more details of the software regularly as we run up to release day. Stay...