Enforce correct block comment usage

Documentos > Datadog Security > Seguridad del código > Static Code Analysis (SAST) > Reglas de SAST > 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

Consecutive block comments are not allowed. However, block comments followed by line comments and vice versa are allowed, as long as there is at least one blank line between them.

Non-Compliant Code Examples

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

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

// Two comments
/* With no line in between */
// Foo

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 ...
 */

// ... as demonstrated here