Best practices for naming conventions, comments, and folder structures
This section will cover some of the industry standards and best practices for developing test automation. Some of the common topics include naming conventions, comments, and folder names and structures.
Naming conventions
When developing the framework, it is important to establish some naming convention standards for each type of file created. In general, this is completely subjective. But it is important to establish them upfront so users can use the same file naming conventions for the same file types to avoid confusion later on, when there are many users building them. Here are a few suggestions:
- Utility classes: Utility classes don't use any prefix or suffix in their names, but do follow Java standards such as having the first letter of each word capitalized, and ending with
.java
extensions. (Acronyms used can be all caps). Examples includeCreateDriver.java
,Global_VARS.java
,BrowserUtils.java
,DataProvider_JSON.java...