Skip to content

Coding guide

azarashi edited this page Jan 12, 2020 · 3 revisions

文字

用語

  • キャメルケース 最初の単語以外の各単語の頭文字を大文字、ほかを小文字とする。
  • パスカルケース 全ての単語の頭文字を大文字、それ以外を小文字とする。

概要

識別子の命名は基本的にキャメルケースまたはパスカルケース。 なおinterfaceについては名前の最初に必ずI(interfaceのI)をつける。

識別子 形式
変数 キャメル
引数 キャメル
メンバー定数 キャメル
静的定数 パスカル
ユーザー定義型 パスカル
列挙子 パスカル
メソッド パスカル
プロパティ パスカル
名前空間 パスカル
イベント パスカル

詳細

変数・引数

キャメルケース。

var camelCaseExampleVariable = 0;
void ExamleMethod(int camelCaseExampleArgument) { }

定数

  • メンバ定数はキャメルケース。最初の単語以外の各単語の頭文字を大文字、ほかを小文字とする。
readonly int camelCaseExampleReadOnly = 0;
  • 静的な定数はパスカルケース。全ての単語の頭文字を大文字、それ以外を小文字とする。
const int PascalCaseExampleConstant = 0;
static readonly int PascalCaseExampleReadOnly = 0;

ユーザー定義型

クラス、インターフェース、構造体、列挙型などのユーザー定義型はパスカルケース。
また、ジェネリックにおける型引数名にも適用する。 なおinterfaceについては名前の最初に必ずI(interfaceのI)をつける。

class PascalCaseExampleClass { }
interface IPascalCaseExample { }
struct PascalCaseExampleStruct { }
enum PascalCaseExampleEnum { }
class PascalCaseExampleGenericClass<PascalCaseType> { }

列挙子

パスカルケース。

enum ExampleEnum
{
    PascalExampleEnumElement1, PascalExampleEnumElement2, PascalExampleEnumElement3
}

メソッド

パスカルケース。

void PascalCaseExampleMethod() { }

プロパティ

パスカルケース。

int PacalExampleProperty { get; set; }

名前空間

パスカルケース。

namespace PascalExampleNameSpace { }

イベント

パスカルケース。ただしUniRxを導入しているためほぼ使用していない。

event ExampleEventHandler PascalCaseExampleEvent;

単語

変数、ユーザー定義型などの命名に使用する単語についてのガイドライン。

現状

英語、リパライン語のラテン転写が入り混じっている。
用途の基準は特にない。

今後の方針

英語版官定ルールのpdfを参考に、一部を除き英語に置き換える。 ただし、駒の名前を置き換えるかに関しては別途検討する。