Enforce block comment alignment

Docs > Plateforme de sécurité Datadog > Code Security > Static Code Analysis (SAST) > SAST Rules > Enforce block comment alignment

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/block-comment-formatting

Language: Kotlin

Severity: Notice

Category: Code Style

Description

Block comments should contain asterisks that visually form a vertical line. This promotes visual simplicity and makes the comment easier to read.

Non-Compliant Code Examples

/*
 * This comment is not formatted well.
   */

/*
  * This comment is not either.
 */

/*
*   Nor is this comment.
 */

Compliant Code Examples

/*
 * This comment is formatted well.
 */

        /*
         * As is this comment.
         */

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