Enforce comment placement in value param

Documentos > Code Analysis > Static Analysis Rules > Enforce comment placement in value param

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-parameter-comment

Language: Kotlin

Severity: Notice

Category: Code Style

Description

No description found

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
)

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