Enforce comment placement in class parameter

Documentos > Datadog Security > Code Security > Static Code Analysis (SAST) > Reglas de SAST > Enforce comment placement in class parameter

Esta página aún no está disponible en español. Estamos trabajando en su traducción.
Si tienes alguna pregunta o comentario sobre nuestro actual proyecto de traducción, no dudes en ponerte en contacto con nosotros.

Metadata

ID: kotlin-code-style/class-parameter-comment

Language: Kotlin

Severity: Notice

Category: Code Style

Description

When defining a class, comments should be placed on a separate line, before the class parameter they document.

Non-Compliant Code Examples

class Foo(
   foo: /** some kdoc */ String
)
class Bar(
    bar:
       // some comment
       String
)

Compliant Code Examples

class Foo(
    /** some kdoc */
    foo: String
)
class Bar(
    // some comment
    bar: String
)