What are some efficient and non-tedious ways to document my page objects?

What I first did was take screen shots of my screen and label each page object to its corresponding web element but this turned out to be a night mare and now I am wondering of more convenient ways to document my page objects so that others can digest which methods or page elements go where with little effort.

I use selenium and page object model to run my tests.

2 Answers 2


I recommend avoiding external documentation because no one wants to maintain it. Instead, use comments in your code and useful names for your classes and methods. And ask someone to review some of your code specifically with those considerations in mind.

  • You are spot on about external documentation - on how no one wants to maintain it. I am the only one that maintains it. And yup we do use comments in our code and useful names. Just wondering if there were more useful resources I could use.
    – Robben
    Sep 3, 2015 at 15:47

Even i feel external documentation is a burden, better way will be distributing page elements meaningfully in into different smaller classes with comments and apt names.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Not the answer you're looking for? Browse other questions tagged or ask your own question.