Skip to Main Content
Visual Studio Hacks
book

Visual Studio Hacks

by James Avery
March 2005
Intermediate to advanced content levelIntermediate to advanced
304 pages
19h 23m
English
O'Reilly Media, Inc.
Content preview from Visual Studio Hacks
Integrate Your Own Documentation into Visual Studio #72
Chapter 8, Comments and Documentation
|
293
HACK
the Visual Studio .NET Integration Kit, and a freely available tool, you can
quickly and somewhat easily integrate your documentation directly into
Visual Studio.
The first step is to download the Visual Studio .NET Integration Kit. NDoc
will use this kit to create your documentation in the HTML Help 2 format,
the format used by Visual Studio. The Visual Studio .NET Integration Kit
can be downloaded from http://msdn.microsoft.com/library/default.asp?url=/
library/en-us/htmlhelp/html/hwmscextendingnethelp.asp.
Create Documentation with NDoc
To integrate help documentation into Visual Studio, you have to generate
your documentation a little bit differently. Instead of creating your docu-
mentation using the MSDN documentation type
[Hack #71], you will need to
create VS.NET 2003-type documentation. This is done by simply selecting
VS.NET 2003 from NDoc’s list of documentation types. (This documenta-
tion type is new to NDoc 1.3, so make sure you have the latest copy of
NDoc.)
You will also need to make a couple configuration changes. Under the
HTML Help 2.0 Deployment section, make sure that GenerateCollection-
File is set to true—you will also need to specify a CollectionNamespace. The
CollectionNamespace should be a unique value similar to your project’s
namespace. (Don’t use a URI, spaces, or special ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Microsoft Visual Studio 2015 Unleashed, Third Edition

Microsoft Visual Studio 2015 Unleashed, Third Edition

Mike Snell, Lars Powers
.Net Framework Essentials

.Net Framework Essentials

Thuan L. Thai, Hoang Lam
C# 5.0 Unleashed

C# 5.0 Unleashed

Bart De Smet
Programming .NET Security

Programming .NET Security

Adam Freeman, Allen Jones

Publisher Resources

ISBN: 0596008473Errata Page