Code Conventions and Guidelines - UserXXX/vCom GitHub Wiki

This page gives an overview of the code conventions and guidelines used for vCom sourcecode in various languages.

General

• use meaningful names (for packages, folders, files, classes, methods and any other thing that has a name)
• every method has exactly one use (e.g. methods like setValueAndRetrieveStatus violate this rule)
• small methods (<= 20 operations)
• query / change separation
• every method or public accessible attribute (constants etc.) has attached documentation (e.g. Javadoc). Exception: Implementations of inherited methods do not neccessarily need documentation

Java

For Java code our own derivate of the Google Java Style is used.