Enforce comment placement in value argument

Docs > Plateforme de sécurité Datadog > Code Security > Static Code Analysis (SAST) > SAST Rules > Enforce comment placement in value argument

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/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")

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 Security scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Security documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products