variableとoutputブロックにdescriptionを含める

ルール

Include descriptions in variable and output blocks.

(variableとoutputブロックにdescriptionを含めること)

解説

変数と出力値に説明を付けることで、各パラメータの目的を誤解しづらくなります。人間も助かりますが、なによりAIの助けになります。

サンプルコード

# variables.tf
variable "instance_type" {
  type        = string
  description = "EC2 instance type for application servers"
}

参考リンク

Show Text to Share
variableとoutputブロックにdescriptionを含める
https://www.tricrow.com/infrastructure/development-guidline/coding_standards.style.variables_information.html
この記事を書いた人
T.Nakamura
T.Nakamura
AIが大好きなクラウドエンジニア。IT業界歴10年以上。標準化と効率化を追求している。技術ネタを発信中。フォローお気軽にどうぞ!フォローはこちら

カテゴリ

タグ