Ranorex Forum

Hello forum;
I want to know if is it possible to generate some documentation for each module (for example that lists all the variables used by the module).
Any tools like javadoc ? for .Net environnements?
Best regards

Hi,

I'm afraid, there is no such tool specifically build for Ranorex. I would suggest to create a feature request here:
https://uservoice.ranorex.com/forums/15 ... ve-ranorex

If you go into the Build tab of the Properties for your projects there is a checkbox you can enable for "XML documentation file" in the Output section.

You can then download Sandcastle Help File Builder here: https://github.com/EWSoftware/SHFB

It has pretty straightforward step-by-step instructions on how to install and run it. You will have to add a couple of the Ranorex DLLs as References within the tool to get it to build the file correctly.

This will pickup the information in your Summary tags so make sure your methods are notated as you want them to show up in your documentation.