略語を避け、完全な名前を使用する

ルール

Avoid abbreviations, use full names (e.g., cgcoding_guidelines). However, abbreviations used as proper nouns (e.g., RDS, id) may be used.

(略語を避け、完全な名前を使用する(例: cgcoding_guidelines)。ただし、固有名詞として使用される略語(例: RDS, id)は使用可能)

解説

独自の略語は外部の人員や将来の担当者が意図を理解しにくくなるため極力利用を控えます。

ただし、RDSやidのような固有名詞に近いものは利用してかまいません。

サンプルコード

# 完全な名前を使用。ただしidのように半ば固有名詞として使われているものは可
variable "security_group_id" {
  type        = string
  description = "Security Group ID"
}

# このような略し方はNG
variable "sg_id" {
  type        = string
  description = "Security Group ID"
}
Show Text to Share
略語を避け、完全な名前を使用する
https://www.tricrow.com/infrastructure/development-guidline/coding_standards.style.acronym.html
この記事を書いた人
T.Nakamura
T.Nakamura
SRE | セキュリティ前提の設計・運用・監査対応(PCI DSS) | ドキュメント整備と仕組み化で開発・運用を整えます | AWS SAP / 日商簿記一級フォローはこちら

カテゴリ

タグ