Skip to content
Sarj Code Standards

no-restated-comment

Flag a short comment attached to an HCL declaration when it only repeats that declaration's kind, label, or attribute name.

SARJ207 Rule source Tests Catalog JSON

Why

A declaration-label comment adds no durable information and can drift; comments that explain constraints, grouping, or operational rationale remain useful.

Fix

Delete the restatement or replace it with the constraint the configuration cannot express. Improve an author-controlled label when the declaration itself is unclear.

Examples

Before — flagged Comment merely narrates an assignment
main.tf
locals {
  # Set instance type
  instance_type = "standard"
}
After — preferred Comment records a provider constraint
main.tf
locals {
  # Keep this type because the provider rejects ARM nodes.
  instance_type = "standard"
}
Autofix output
main.tf
locals {


  instance_type = "standard"
}
Before — flagged Maintained block comment repeats its attribute
main.tf
locals {
  /* Set instance type */
  instance_type = "standard"
}
After — preferred Generated HCL is owned by its generator
generated.tf
/* Code generated by schema compiler.
 * DO NOT EDIT.
 */
locals {
  # Set instance type
  instance_type = "standard"
}
Before — flagged Comment repeats one declaration label
main.tf
locals {
  # Service account
  service_account_email = "api@example.test"
}
After — preferred Comment labels a group of sibling attributes
main.tf
locals {
  # Service accounts
  api_service_account_email    = "api@example.test"
  worker_service_account_email = "worker@example.test"
}