Naming Conventions

The following naming conventions are used by all chapters in the ‘Best Practices’ documentation. They help you to comprehend the documentation more easily. This is important in order not to mix the different levels of abstraction.

Generators

Wherever the name of a code generator is mentioned, that name is shown with an italic font and a grey background color, like this:
JSF Web Fragment
JPA

Model Elements

Names of model elements are mentioned as TheNameOfAModelElement.

File and Directory Names

File and directory names are shown with a bold font. Those names typically contain names of model elements. The portion of a file name that comes from a model element name is shown with a yellow background like this:

Model: type TheNameOfAModelElement

File Name: TheNameOfAModelElementEventHandler.java

Code and Configuration

Text that is found in code or configuration files is highlighted like this:
MyType
<init-param>paramName</init-param>

Extracts from code or configuration files that span more than one line are shown like this:

public class MyType {

    private String name;

    ...
}

In contrast to the display rules for file and directory names, a model element name is not highlighted with a yellow background color in order not to decrease the readability of the code/configuration.