Skip to content

Checkstyle and IDEs

Jonathan Austin edited this page Feb 15, 2022 · 3 revisions

Developers need to configure their IDE to match the code style enforced by qa-parent and the Checkstyle plugin.

The checkstyle plugin is configured to use bordertech/bt-checkstyle.xml. This config is based on sun-checks.xml provided by checkstyle and any overrides are flagged with a comment bordertech in the xml.

The overrides are based on making the config as close as possible to the default code style used by the 3 main IDEs IntelliJ, Netbeans and Eclipse.

As there are some variations between the IDEs, the following settings may need to be checked:

  • Line length of 150 characters
  • TAB indenting
  • Auto reformat code on save
  • Remove unused imports on save
  • In IntelliJ, dont wildcard imports. Set the limit to 99.

The other coding styles are usually covered by the defaults in the IDEs.

Clone this wiki locally