Design time documentation preview

Topics: Developer Forum
Apr 18, 2012 at 4:57 PM

Eric, fantastic job on the VS integration and bug fixes to Sandcastle for the latest release.

I came across the following DevExpress add-on that provides an XML documentation preview in VS.

http://code.google.com/p/cr-documentor/

It would be great if somewhere in the Sandcastle family of projects, such functionality could be provided for users who don't have a DevExpress license.  It really streamlines code documentation.

Coordinator
Apr 18, 2012 at 8:21 PM

Thanks, I'm glad you like the new version.  Regarding the CR-Documentor, I'm pretty sure that DXCore that it's build on is free for download if you register (http://devexpress.com/Products/Visual_Studio_Add-in/DXCore/).  I haven't tried it so I could be wrong but it's worth checking out.  I could probably do something similar to the topic previewer for the XML comments files in a SHFB project although the info would only be as current as the last time they were built.  Deeper integration for dynamic rendering would take some research.  It's an interesting idea though so I'll perhaps take a look at it in the future.

Eric

 

Apr 18, 2012 at 8:33 PM

Excellent.  I did not realize it was free since I happen to have Refactor! on my machine which includes DXCore.  I had just assumed DXCore was part of their products.   I wouldn't make an effort then.   Keep up the good work.