Metadata

ID: kotlin-code-style/annotation-spacing

Language: Kotlin

Severity: Notice

Category: Code Style

Description

Each annotations should be placed on a separate line. This is important because it makes the code more readable and easier to understand. When multiple annotations are placed on the same line, it can become difficult to distinguish between them and understand their individual impacts on the associated code.

Non-Compliant Code Examples

@JvmField

fun foo() {}

@Foo @Bar
/**
 * block comment
 */
class FooBar {
}

Compliant Code Examples

@Serializable
class CreateActionRequest {
    @Suppress("unused") // All fields are required
    @Serializable
    private class Data(val id: String, val attributes: Attributes) {
        @EncodeDefault
        val type = "something"
    }
}

@JvmField
fun foo() {}

@JvmField
fun foo(
    x: Int
) {}

/**
 * block comment
 */
@Foo
class FooBar {
}

@Foo
@Bar
class FooBar {
}