Private property naming convention

Last modified: 03 December 2024

Reports private property names that do not follow the recommended naming conventions.

Consistent naming allows for easier code reading and understanding. According to the Kotlin official style guide, private property names should start with a lowercase letter and use camel case. Optionally, underscore prefix is allowed but only for private properties.

It is possible to introduce other naming rules by changing the "Pattern" regular expression.

Example:

val _My_Cool_Property = ""

The quick-fix renames the class according to the Kotlin naming conventions:

val _myCoolProperty = ""

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

PrivatePropertyName
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Kotlin | Naming conventions

Inspection options

Here you can find the description of settings available for the Private property naming convention inspection, and the reference of their default values.

Pattern

_?[a-z][A-Za-z\d]*

Inspection Details

By default bundled with:

IntelliJ IDEA 2024.3, Qodana for JVM 2024.3,

Can be installed with plugin:

Kotlin, 243.23126-IJ