Enforce correct block comment usage

Documentos > Code Analysis > Static Analysis Rules > Enforce correct block comment usage

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/no-consecutive-comments

Language: Kotlin

Severity: Notice

Category: Code Style

Description

No description found

Non-Compliant Code Examples

/*
 * Block comments can not be consecutive ...
 */

/*
 * ... even when separated by a new line.
 */

Compliant Code Examples

// An EOL comment
// may be followed by another EOL comment
val foo = "foo"

// Different comment types (including KDoc) may be consecutive ..

/*
 * ... but do need to be separated by a blank line ...
 */

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