Local variable naming convention

Reports local variables that do not follow the naming conventions.

You can specify the required pattern in the inspection options.

Recommended naming conventions: it has to start with a lowercase letter, use camel case and no underscores.

Example:

  fun fibonacciNumber(index: Int): Long = when(index) {
      0 -> 0
      else -> {
          // does not follow naming conventions: contains underscore symbol (`_`)
          var number_one: Long = 0
          // does not follow naming conventions: starts with an uppercase letter
          var NUMBER_TWO: Long = 1
          // follow naming conventions: starts with a lowercase letter, use camel case and no underscores.
          var numberThree: Long = number_one + NUMBER_TWO

          for(currentIndex in 2..index) {
              numberThree = number_one + NUMBER_TWO
              number_one = NUMBER_TWO
              NUMBER_TWO = numberThree
          }
          numberThree
      }
  }

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.

LocalVariableName

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 Local variable 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

Last modified: 03 December 2024