Avoid very short function names

Docs > Code Analysis > Static Analysis Rules > Avoid very short function names

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: kotlin-code-style/function-name-min-length

Language: Kotlin

Severity: Notice

Category: Code Style

Description

Function names should be descriptive of the function behavior and functionalities. Instead of using a very short name, always have a name that indicates what the function is doing.

Arguments

min-length: Minimum length for function names. Default: 2.

Non-Compliant Code Examples

fun a() {
    
}

Compliant Code Examples

fun valid() {
    
}

infix fun to() {
    
}

How to use this rule

1
2
rulesets:
  - kotlin-code-style     # Rules to enforce Kotlin code style.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products