Use clear, descriptive names instead of cryptic abbreviations, and follow consistent naming patterns across your codebase. This practice enhances readability and maintainability.
Use clear, descriptive names instead of cryptic abbreviations, and follow consistent naming patterns across your codebase. This practice enhances readability and maintainability.
For configuration properties and attributes:
authentication-token
instead of otac
)jdk-version-latest
instead of JDK-ver-latest
)For package naming:
io.<organization>.<component-name>
)For all identifiers, choose terms that avoid ambiguity with similar concepts in your domain to prevent confusion.
Example:
# Less clear:
quarkus.http.auth.form.otac.enabled=true
# More clear:
quarkus.http.auth.form.authentication-token.enabled=true
// Less clear package structure
package io.quarkus.cache;
// More clear and consistent package structure
package io.quarkus.extension.cache;
Enter the URL of a public GitHub repository