TypeScriptの命名規則の早見表

これはなに Link to this heading

Google TypeScript Style Guide を基に作成した、個人的な命名規則の早見表。

命名規則 Link to this heading

使用する文字 Link to this heading

  • 名前にはASCII文字と数字のみを使用する
  • アンダースコアは定数(UPPER_SNAKE_CASE)のみ許される
  • Observablesのみ$を付けてもよい

命名のルール Link to this heading

  • 名前に型名を付けない、 ハンガリー記法を使用しない
  • インターフェースにIInterfaceをつけない
  • 接頭辞または接尾辞に_を使わない
  • 単語を省略しない、曖昧な略語/馴染みのない略語は使わない
    • もし、スコープが10行以下なら、短い(例えば1文字)変数名を使っても良い
    • 型パラメータは大文字1文字(e.g. T)でもよい
  • たとえ頭字語であっても、2文字目から小文字にする(e.g. Url

記述スタイル Link to this heading

カテゴリスタイル
変数camelCase
関数camelCase
クラスPascalCase
メンバ変数camelCase
メンバ関数camelCase
インターフェースPascalCase
PascalCase
名前空間PascalCase
EnumPascalCase
EnumメンバUPPER_SNAKE_CASE
グローバル定数UPPER_SNAKE_CASE
ファイル名camelCase
  • 技術的に変更できるが変更を意図していない定数にはUPPER_SNAKE_CASEを用いる

参考文献・URL Link to this heading

Google TypeScript Style Guide's image

Google TypeScript Style Guide

google.github.io
Licensed under CC BY-NC-SA 4.0
最終更新 9月 11, 2024
Hugo で構築されています。
テーマ StackJimmy によって設計されています。