December 2006
Intermediate to advanced
1312 pages
35h 17m
English
Content preview from Windows Developer Power Tools
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,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
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 ...
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.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.