설명
output에 description이 없으면 모듈 사용자가 값의 용도와 형식을 코드에서 추측해야 할 수 있습니다. 설명 부족은 문서화와 유지보수의 문제입니다.
잠재적 영향
출력값을 잘못 사용하거나 모듈을 인수인계할 때 혼동할 수 있습니다.
해결 방법
각 output에 반환값의 의미와 사용 목적을 설명하는 description을 추가하세요. 필요한 경우 단위나 형식도 적으세요.
예시
EKS 클러스터 이름 출력에 설명을 추가하는 예시입니다. 참조하는 클러스터 리소스는 생략했습니다.
변경 전
hcl
output "cluster_name" {
value = aws_eks_cluster.main.name
}
변경 후
hcl
output "cluster_name" {
value = aws_eks_cluster.main.name
description = "생성된 EKS 클러스터 이름"
}