Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: "1.4 Punctuation" item added.

...

Java code has a column limit of 140 characters.

1.3 Horizontal alignment is disallowed

...

This rule overrides section 4.6.3 of Google Java Style Guide.

Alignment can aid readability, but it creates problems for future maintenance. So horizontal alignment is disallowed.

1.4 Punctuation

All natural language sentences must follow generally accepted punctuation rules. It also means that every sentence must end with dot (.), exclamation point (!) or question mark (?) depending on a sentence semantic. This requirement applies to:

  • Code comments (JavaDoc and regular comments).
  • Any descriptive messages (for example metrics or JMX properties description).
  • Exception messages.
  • Log messages.
  • Console output.

Exclusions:

  • Titles of table rows/columns.
  • Content of table cells if this cell contains status enum-like value (e.g. status), numeric value, named value (e.g. entity name).
  • Header titles at any level (for example, documentation/comments).

2 Nullability annotation usages

...