CR_Documentor - The Documentor Plug-In for DXCore

UPDATE: CR_Documentor has found a new home on Google Code. Head over there to get the latest version and updated information.

 

Lutz Roeder, a fantastic developer of ultra-helpful tools, took his "Documentor" application - which allowed a developer to preview what XML document comments would look like rendered into end-user documentation - down from his site. He was nice enough to send me the source for it, though, so I've converted it into a Visual Studio tool window add-in via the rich plug-in framework offered by the Developer Express, Inc. package, DXCore (which also supports CodeRush for Visual Studio .NET).

This plug-in allows you to see a preview of your XML document comments - a la Roeder's original Documentor - real-time, as you edit the comments in Visual Studio.

CR_Documentor at work - click to enlarge

CR_Documentor offers the ability to choose the level of tags you want to be "compatible" with, the manner in which "unrecognized" tags are handled, and other formatting options.

CR_Documentor Options - click to enlarge

CR_Documentor also offers context-menu support to aid in working with XML documentation comments, including inserting templates, embedding selections in templates, toggling outlining on XML doc comments, and toggling visibility of the CR_Documentor window.

Installation is as easy as copying a DLL into a folder. The included readme.txt outlines installation, usage, and workarounds for known issues.

UPDATE: CR_Documentor has found a new home on Google Code. Head over there to get the latest version and updated information.

posted on Monday, November 15, 2004 12:06 PM | Filed Under [ Software / Downloads .NET Visual Studio ]

Comments

Gravatar # ComputerZen.com - Scott Hanselman's Weblog - My GrokTalk - Ten Tools in Ten Minutes
by www.hanselman.com at 6/9/2005 1:36 AM
Gravatar # ComputerZen.com - Scott Hanselman's Weblog - Scott Hanselman's 2005 Ultimate Developer and Power Users Tool List
by www.hanselman.com at 6/19/2005 9:52 PM
Gravatar # Jelle Druyts - Two Cool Tools
by jelle.druyts.net at 10/18/2005 10:23 AM
Gravatar # Andrew Stopford's Weblog : Documenting your API's
by weblogs.asp.net at 7/13/2006 9:32 AM
Gravatar # Scott Hanselman's Computer Zen - Scott Hanselman's 2006 Ultimate Developer and Power Users Tool List for Windows
by www.hanselman.com at 8/29/2006 1:40 AM
Gravatar # Josh Holmes Blog - Grok Talk for GANG - 10 Dev Tools in 10 Minutes
by www.joshholmes.com at 10/19/2006 8:29 AM
Gravatar # CR_Documentor and XSLT May Be Harder Than I Thought
by Paraesthesia at 8/6/2007 10:31 AM
CR_Documentor and XSLT May Be Harder Than I Thought
Gravatar # re: CR_Documentor - The Documentor Plug-In for DXCore
by Arran at 8/9/2007 7:48 AM
Context menu, no option for insert template, just Expand, Collapse and Hide CR_Documentor.

PS cool tool, keep it up
Gravatar # re: CR_Documentor - The Documentor Plug-In for DXCore
by Travis Illig at 8/9/2007 7:54 AM
You will only see the insert template stuff when you're in an XML doc comment. Throw the three slashes /// in first and if it's the right spot for an XML doc comment, the DXCore parser will pick that up, let me know, and my context menu will show the additional options.
Comments have been closed on this topic.