CODEWITHSUNDEEP
visual-studio-codeterraformcomments
ngum ebune
ngum ebune

Reputation: 131

How to comment out Terraform code on VS Code

I wish to find out how to comment out Terraform code on VS Code. I am new to the world of coding, and AWS. I am still learning to use Terraform.

Upvotes: 13

Views: 47154

Answers (3)

Karkala Srikanth
Karkala Srikanth

Reputation: 93

The Terraform language supports three different syntaxes for comments:

  1. hash # begins a single-line comment, ending at the end of the line.
  2. // also begins a single-line comment, as an alternative to #.
  3. /* and */ are start and end delimiters for a comment that might span over multiple lines.

The # single-line comment style is the default comment style and should be used in most cases. Automatic configuration formatting tools may automatically transform // comments into # comments, since the double-slash style is not idiomatic.

Upvotes: -2

Guy
Guy

Reputation: 231

Attaching the Terraform documentation for commenting

The Terraform language supports three different syntaxes for comments:

# begins a single-line comment, ending at the end of the line.

// also begins a single-line comment, as an alternative to #.

/* and */ are start and end delimiters for a comment that might span over multiple lines.

The # single-line comment style is the default comment style and should be used in most cases. Automatic configuration formatting tools may automatically transform // comments into # comments, since the double-slash style is not idiomatic.

Upvotes: 23

Alex Ringelmann
Alex Ringelmann

Reputation: 51

The most common way to comment out code in Terraform is to add a hash at the start of the lines:

variable "var_1" {
  type    = string
  default = "value-1"
}

# variable "var_2" {
#   type    = string
#   default = "value-2"
# }

In the above example, Terraform will create the variable called var_1, but will not create the variable called var_2 because that variable has been commented out.

You can check out the Terraform Configuration Syntax.

Upvotes: 1

Related Questions