QHR Style Guide Version 2

Installation Instructions

IntelliJ and NetBeans

Set up your IDE to automatically format code according to convention. See the Confluence document "Set Up Code Styles in IDEs"

Checkstyle Configuration

Enforce conventions for coding styles. See the Confluence document "Enforce Coding Styles on a Project"

File Descriptions

• src/main/resources - Contains checkstyle xml configurations
  • qhr-checkstyle.xml - QHR Style Guide 1.0 (Deprecated)
• checkstyle-google_checks_qhr_strict.xml - The full checks based on the official Google Style Guide
• checkstyle-google_checks_qhr_strict_code.xml - All non-Javadocs checks based on the official Google Style Guide
• checkstyle-google_checks_qhr_transitional.xml - A less strict verion of the Google Style Guide meant to facilitate the transition between QHR Style Guide 1.0 and Google Style Guide
• eclipse-java-qhr-style.xml - Eclipse code style configuration, works with Eclipse code formatter plugins
• maven-codestyleProfile.xml - A snippet from pom.xml to add checkstyle to a project
• netbeansConfiguration.xml - A snippet from pom.xml to add code styles (formatting) to a project
• intellij_codestyle_qhr.xml - IntelliJ code style schema, must be imported and applied to projects
• pom.xml - The maven project file to build checkstyle jars. This is not a reference for configuring other poms with the checkstyle.