自己記述的な名前 (Self-Documenting Names)

定義

**自己記述的な名前 (Self-Documenting Names)**は、識別子の役割と粒度を読者へ伝える命名規則である。タイトル中の「Self-Documenting Names」は、この概念を適用する条件または具体的な構成要素を示す。

仕組みと具体例

真偽値を isEnabled、操作を動詞、型を名詞にすると利用側で意図を推測しやすい。実際に適用するときは、通常時だけでなく境界値、失敗、並行実行、外部依存の変化が結果へどう影響するかを追跡する。

実践と検証

省略語と表記揺れを抑え、スコープが広いほど具体的な名前を使う。期待する結果を観測可能な条件で記述し、最小の例から始めて異常系を追加する。自動化する場合も、基準自体が妥当かをレビューする。

トレードオフ

この手法の導入は一貫性と再現性を高める一方、設定、抽象、運用対象を増やす場合がある。適用範囲を広げる前に、解決するリスクと維持コストを比較する。例外は暗黙にせず、理由、期限、代替策を記録する。