Comments in HCL in Terraform - Cheat Sheet & Quick Revision

Recall & Review

beginner

What symbol is used for a single-line comment in HCL?

The # or // symbols are used for single-line comments in HCL.

beginner

How do you write a multi-line comment in HCL?

Use /* to start and */ to end a multi-line comment in HCL.

beginner

Why are comments useful in Terraform configuration files?

Comments help explain the purpose of code, making it easier to understand and maintain.

beginner

Can comments affect the behavior of Terraform configurations?

No, comments are ignored by Terraform and do not affect configuration behavior.

beginner

Show an example of a single-line and a multi-line comment in HCL.

Single-line comment: # This is a comment or // This is a comment<br>Multi-line comment:<br>/*<br>This is a<br>multi-line comment<br>*/

Which of the following is NOT a valid way to write a comment in HCL?

A <!-- This is a comment -->

B # This is a comment

C // This is a comment

D /* This is a comment */

HCL does not support HTML-style comments like . Use #, //, or /* */ instead.

What happens to comments when Terraform processes a configuration file?

A They are executed as code

B They are converted to variables

C They are ignored

D They cause errors

Terraform ignores comments; they do not affect the configuration or execution.

Which symbols can start a single-line comment in HCL?

A # and //

B /* and */

C <!-- and -->

D -- and ##

Single-line comments in HCL start with either # or //.

How do you write a multi-line comment in HCL?

A Use <code>--</code> at the start and end

B Start with <code>#</code> on each line

C Use <code>//</code> on each line

D Enclose text between <code>/*</code> and <code>*/</code>

Multi-line comments in HCL are enclosed between /* and */.

Why should you use comments in your Terraform files?

A To make the code run faster

B To explain code for better understanding

C To hide code from Terraform

D To create variables

Comments help explain the code, making it easier for others (and yourself) to understand and maintain.

Explain how to write single-line and multi-line comments in HCL and why they are important.

Think about how you add notes in a text to help yourself or others understand it later.

Describe the impact of comments on Terraform configuration behavior.

Consider if Terraform treats comments like code or just skips them.