Methods Annotations | Bondar Academy

Lesson Summary

In this lesson, the focus is on enhancing the clarity of page object methods in your code, making it easier for others to understand their functionality. Key Concepts Method Clarity: It's important that method names clearly describe their actions, but parameters can often be confusing. Using Annotations: Adding test annotations or method annotations can significantly improve the understanding of methods and their parameters. Steps to Add Annotations Place the cursor above the method name. Type / followed by ** and hit Enter . This will create a documentation block. Provide a description of the method and its parameters. Example For a method named submitUsingGridForm , you can describe it as: /** * Method to submit using the grid form with valid user credentials. * * @param {string} email - Valid user email. * @param {string} password - Valid user password. * @param {number} optionIndex - Index of the option radio button (starts from zero). */ Benefits of Annotations Improves readability and understanding of the method's purpose. Provides data types for parameters, which helps during development. Assists in auto-completion features in IDEs like Visual Studio Code. By consistently adding such annotations, you make your code more understandable for yourself and others, enhancing collaboration and maintenance. Remember, clear documentation is key!