Skip to content

Coding conventions #33

@sbesson

Description

@sbesson

In order to simplify future code review, it would be beneficial to adopt a code style for this component and enforce it at build time via the checkstyle Gradle plugin as we already do in other Java libraries like bioformats2raw

As a starting point, running the two primary codestyle examples from Checkstyle against the current HEAD of this repository gives the following output

Importantly, the majority of the Google's Java Style violations are related to indentation warnings as this style uses 2 spaces as opposed to 4 as currently used in this component. A modified version of the Google's Java Style using the Checkstyle's default Indentation rules reports 195 violations.

@kkoz @chris-allan Unless there are specific rules you would like to see applied here, my proposal would be to use the modified version of Google's Java Style with the default Checkstyle indentation and work through the set of changes required to have this library adhere with these conventions
Thinking forward and outside the scope of this library., it would be beneficial to use code style conventions that are compatible with the style of the OMERO Java components under the org.openmicroscopy namespace.

Originally posted by @kkoz in #28 (comment)

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions