github.com/jpreese/tflint@v0.19.2-0.20200908152133-b01686250fb6/docs/rules/terraform_comment_syntax.md (about)

     1  # terraform_comment_syntax
     2  
     3  Disallow `//` comments in favor of `#`.
     4  
     5  ## Example
     6  
     7  ```hcl
     8  # Good
     9  // Bad
    10  ```
    11  
    12  ```
    13  $ tflint
    14  1 issue(s) found:
    15  
    16  Warning: Single line comments should begin with # (terraform_comment_syntax)
    17  
    18    on main.tf line 2:
    19     2: // Bad
    20  
    21  Reference: https://github.com/terraform-linters/tflint/blob/v0.16.0/docs/rules/terraform_typed_variables.md
    22  ```
    23  
    24  ## Why
    25  
    26  The Terraform language supports two different syntaxes for single-line comments: `#` and `//`. However, `#` is the default comment style and should be used in most cases.
    27  
    28  * [Configuration Syntax: Comments](https://www.terraform.io/docs/configuration/syntax.html#comments)
    29  
    30  ## How To Fix
    31  
    32  Replace the leading double-slash (`//`) in your comment with the number sign (`#`).