これはなに
Google TypeScript Style Guide を基に作成した、個人的な命名規則の早見表。
命名規則
使用する文字
- 名前にはASCII文字と数字のみを使用する
- アンダースコアは定数(
UPPER_SNAKE_CASE
)のみ許される - Observablesのみ
$
を付けてもよい
命名のルール
- 名前に型名を付けない、 ハンガリー記法を使用しない
- インターフェースに
I
やInterface
をつけない - 接頭辞または接尾辞に
_
を使わない - 単語を省略しない、曖昧な略語/馴染みのない略語は使わない
- もし、スコープが10行以下なら、短い(例えば1文字)変数名を使っても良い
- 型パラメータは大文字1文字(e.g.
T
)でもよい
- たとえ頭字語であっても、2文字目から小文字にする(e.g.
Url
)
記述スタイル
カテゴリ | スタイル |
---|---|
変数 | camelCase |
関数 | camelCase |
クラス | PascalCase |
メンバ変数 | camelCase |
メンバ関数 | camelCase |
インターフェース | PascalCase |
型 | PascalCase |
名前空間 | PascalCase |
Enum | PascalCase |
Enumメンバ | UPPER_SNAKE_CASE |
グローバル定数 | UPPER_SNAKE_CASE |
ファイル名 | camelCase |
- 技術的に変更できるが変更を意図していない定数には
UPPER_SNAKE_CASE
を用いる