Skip to content

Commit ff1382e

Browse files
authored
added the obvious missing case: no special chars
1 parent 70b7859 commit ff1382e

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

documentation/coding-conventions.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ The code should follow general conventions for Java (see http://www.oracle.com/t
77
Besides general Java naming conventions, we follow the additional rules listed here explicitly:
88

99
* Always use short but speaking names (for types, methods, fields, parameters, variables, constants, etc.).
10+
* Strictly avoid special characters in technical names (for files, types, fields, methods, properties, variables, database tables, columns, constraints, etc.). In other words only use Latin alpahnumeric ASCII characters with the common allowed technical separators for the accordign context (e.g. underscore) for technical names (even excluding whitespaces).
1011
* For package segments and type names prefer singular forms (`CustomerEntity` instead of [line-through]`CustomersEntity`). Only use plural forms when there is no singular or it is really semantically required (e.g. for a container that contains multiple of such objects).
1112
* Avoid having duplicate type names. The name of a class, interface, enum or annotation should be unique within your project unless this is intentionally desired in a special and reasonable situation.
1213
* Avoid artificial naming constructs such as prefixes (`I*`) or suffixes (`*IF`) for interfaces.

0 commit comments

Comments
 (0)