Why Comments in HCL in Terraform? - Purpose & Use Cases

The Big Idea

Want to save hours of confusion and fix mistakes before they happen? Comments are your secret weapon!

The Scenario

Imagine you are writing a long list of instructions to build your cloud setup by hand, without any notes or explanations.

Later, when you or someone else looks at it, it's hard to understand why certain choices were made.

The Problem

Without comments, it's easy to forget the purpose of each part.

This leads to confusion, mistakes, and wasted time trying to figure out what the code does.

The Solution

Comments in HCL let you add simple notes inside your code.

These notes don't affect how the code runs but help anyone reading it understand the why behind each step.

Before vs After

✗ Before

resource "aws_instance" "web" {
  ami = "ami-123456"
  instance_type = "t2.micro"
}

✓ After

# This is the web server instance
resource "aws_instance" "web" {
  ami = "ami-123456"  # Use latest stable AMI
  instance_type = "t2.micro"  # Small instance for testing
}

What It Enables

Clear, easy-to-understand infrastructure code that anyone can maintain and improve.

Real Life Example

A team managing cloud servers can quickly see why a specific server type was chosen or why a setting is set a certain way, avoiding costly mistakes.

Key Takeaways

Comments explain your code's purpose.

They make teamwork smoother and faster.

They prevent confusion and errors.