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 Sharevariableとoutputブロックにdescriptionを含める https://www.tricrow.com/infrastructure/development-guidline/coding_standards.style.variables_information.html

