まくろぐ

TypeScript のコーディング規約(ルール/ガイドライン)

更新:
作成:

TypeScript 自体のコントリビューター用のコーディングルールは下記のサイトで定義されています。 ユーザーレベルの開発プロジェクトに強制するものではないと注記がありますが、多くのルールはそのまま採用できると思います。

例えば、次のようなことが書かれています。

  • インデントは 4文字
  • ドキュメンテーションコメントには JSDoc の記法を使う
  • Names(命名規則)
    • 型名(クラス名、列挙型、エイリアスなど)は PascalCase
    • 変数名や関数名は camelCase
    • プライベートプロパティ名を _ で始めない
  • 文字列リテラル は ダブルクォーテーション で囲む
  • null は使用せずに常に undefined を使う(undefinednull は同じものとして使って通常は問題ないので)
  • for..in ではなく、x.forEachx.forEachKeyx.forEachValue を使用する
  • 開き括弧 ({) は同じ行の末尾に記述する。else の前に改行する。

関連記事

まくろぐ
サイトマップまくへのメッセージ