Enforce block comment alignment

Documentos > Datadog Security > Seguridad del código > Static Code Analysis (SAST) > Reglas de SAST > Enforce block comment alignment

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

Cómo usar esta regla

1
2
rulesets:
  - kotlin-code-style     # Rules to enforce Kotlin code style.

Crea un static-analysis.datadog.yml con el contenido anterior en la raíz de tu repositorio
Utiliza nuestros complementos del IDE gratuitos o añade análisis de Code Security a tus pipelines de CI.
Recibe comentarios sobre tu código

Para más información, lee la documentación sobre Code Security

Extensión de VS Code

Identifica vulnerabilidades del código directamente en tu editor de
VS Code

Complemento de JetBrains

Identifica vulnerabilidades del código directamente en los productos de
JetBrains