*.tfファイルのコメントを最小限に保つ
ルール
*Keep comments in .tf files to a minimum. Avoid adding header blocks or documentation-level specifications in comments.
（*.tfファイルのコメントを最小限に保つ。ヘッダーブロックの追加禁止。またドキュメントに記載すべき仕様も書いてはならない）
解説
生成AIはしばしば大量のコメントやヘッダーブロックをコード内に埋め込もうとします。しかし過剰なコメントは可読性を落とし、コメントの保守の手間を増やし、トークン効率を悪化させます。そのため禁止しています。
サンプルコード
# 良い例: 最小限のコメント、自己文書化されたコード
variable "instance_type" {
type = string
description = "EC2インスタンスタイプ。本番環境ではt3.mediumを推奨"
}
resource "aws_instance" "web" {
ami = data.aws_ami.ubuntu.id
instance_type = var.instance_type
# セキュリティ要件により、IMDSv2を強制
metadata_options {
http_endpoint = "enabled"
http_tokens = "required"
}
}
*.tfファイルのコメントを最小限に保つ https://www.tricrow.com/infrastructure/development-guidline/coding_standards.style.comments_minimal.html
