Generating Compiled Help Files

When you document your source code with XML comments, you might want to generate compiled help files that you can distribute together with your libraries. Generally compiled help files are .chm files that can be easily opened with the Windows integrated Help Viewer. The .chm file format is the most appropriate in such situations because it is a standalone and does not require additional applications. There are several tools that can generate .chm files starting from XML documents, but probably the most common is Microsoft SandCastle, an open source tool from Microsoft that is also used to build documentation. SandCastle is a great tool with one limitation: It works from the command line only, and command lines ...

Get Visual Basic® 2010 Unleashed now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.