7.2 Viewing Documentation in Visual Studio with CR_Documentor
XML comments, combined with NDoc, are a very powerful tool, enabling you to create powerful API and system documentation to help others understand how your system works.
Unfortunately, the process of generating NDoc help files is quite involved: you must write your XML comments, then build your project in Visual Studio to create the XML documentation file(s), and then run NDoc against those files to build your final output documentation. This can be annoyingly time-consuming when all you’re trying to do is ensure you’re properly formatting a few comment tags.
Travis Illig’s CR_Documentor eliminates the chain of events after you write XML comments—his DXCore plug-in renders your XML comments exactly like you’d see them as output from NDoc.
| |
|---|---|
Tool | CR_Documentor |
Version covered | 1.8.2.0510 |
Home page | http://www.paraesthesia.com/blog/comments.php?id=701_0_1_0_C |
Power Tools page | |
Summary | Preview your XML documentation right inside Visual Studio |
License type | Freeware (plug-in only; DXCore restricted) |
Online resources | |
Supported Frameworks | .NET 1.0, 1.1, 2.0 |
Related tools in this book | GhostDoc, NDoc, CR_Metrics |
Getting Started
CR_Documentor is a plug-in for DXCore, the engine behind CodeRush and Refactor! by Developer Express. You’ll already have DXCore if you have either of those ...
Get Windows Developer Power Tools 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.
