Cr-Documentor - A Cool DXCore Plug-in for Visual Studio

May be I am last person on the Earth, who discovered and started using this way too cool plug-in recently ….however, if you have not checked it out yet – probably you should do it now :).

Cr_Documentor gives you just-in time rendering of your XML Documentation to preview it. So, you can update your documentation and at the same time you can preview it how it would look like after you generate documentation for your project using rendering engine like NDoc or SandCastle –

1cr_documentor_realtime

It gives you real time error message if there is any error with the documentation you created. For example , in the following example, since in line 16 , I missed “name” attribute in paramref , it is showing the error with red bold letter :) -

 

2cr_documentor_error

After fixing the problem,  it looks -

3cr_documentor2

In addition , Cr_Documentor  provides a context menu that presents great support  for documentation like-

 

4cr_documentor_contextmenu

Last but not the least, Cr_Documentor also offers options to configure the compatibility level , unrecognized tag handling , Formatting , Display and preview  -

Using the options , you can really configure different aspects of your Documentation. For example, if you change the preview style to SandCastle – the preview will look like -

7cr_documentor_sandcastle

If you want to check it out , you will have to download and Install the DxCore ( A Powerful extensibility framework for Visual Studio) first. Then, you can download and get more details about Cr_Documentor from Google Code.

In conclusion , by leveraging Cr_Documentor, writing and maintaining Xml Documentation for your projects would be far more easy and less error-prone. I can’t help thanking Lutz Roeder and Travis Illig for taking it this far. It’s just wonderful !!!

 

No Comments