Enforce comment placement in value argument

Documentos > Datadog Security > Seguridad del código > Static Code Analysis (SAST) > Reglas de SAST > Enforce comment placement in value argument

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: kotlin-code-style/value-argument-comment

Language: Kotlin

Severity: Notice

Category: Code Style

Description

Having comments between the name of a named argument and its value makes code harder to read and can lead to confusion.

Non-Compliant Code Examples

doTask(name = "parse", filename = /* A list of IP addresses */ "ips.txt")

doTask(
    name = "parse",
    filename =
    // A list of IP addresses
        "ips.txt"
)

Compliant Code Examples

doTask(name = "parse", filename = "ips.txt")

Cómo usar esta regla

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

Crea un static-analysis.datadog.yml con el contenido anterior en la raíz de tu repositorio
Utiliza nuestros complementos del IDE gratuitos o añade análisis de Code Security a tus pipelines de CI.
Recibe comentarios sobre tu código

Para más información, lee la documentación sobre Code Security

Extensión de VS Code

Identifica vulnerabilidades del código directamente en tu editor de
VS Code

Complemento de JetBrains

Identifica vulnerabilidades del código directamente en los productos de
JetBrains