How to add description for modules

Best practices, code snippets for common functionality, examples, and guidelines.
Posts: 4
Joined: Mon Dec 08, 2014 4:41 am

How to add description for modules

Post by Deepa_8746 » Mon Feb 15, 2016 4:34 am


In our project, we use module that have many variables with specific expected values for the same.
For the ease of use of testers, is it possible in any way to add a description of the modules.

Eg: What action it performs and what is the exact expected values of the variables to be specified for binding.

User avatar
Ranorex Guru
Ranorex Guru
Posts: 7465
Joined: Mon Aug 13, 2012 9:54 am
Location: Zilina, Slovakia

Re: How to add description for modules

Post by odklizec » Mon Feb 15, 2016 9:09 am


As far as I know, the only module-based description can be added via XMLDoc Summary: ... html#c6520
Pavel Kudrys
Ranorex explorer at Descartes Systems

Please add these details to your questions:
  • Ranorex Snapshot. Learn how to create one >here<
  • Ranorex xPath of problematic element(s)
  • Ranorex version
  • OS version
  • HW configuration

Posts: 2683
Joined: Tue Feb 07, 2012 4:14 pm
Location: Austin, Texas, USA

Re: How to add description for modules

Post by krstcs » Mon Feb 15, 2016 4:00 pm

Or you could just name your modules appropriately so the name shows exactly what the module does. But if you make your modules really big, this won't work as well (not to mention that big modules are harder to maintain).

My modules are very small, and do ONE thing each...

"Click_OKButton.rxrec" => Clicks the OK button...
"Enter_Password" => Enters the password in the Password field with the variable Password...

Then you just have to drag-and-drop the modules in your test cases the way they need to be and your modules are the steps and the test cases are test cases...
Shortcuts usually aren't...