変数名の付け方について

もっけ
もっけ

プログラミングの変数名には、命名規則があるんだ。

変数名は役割が分かる名前にするのが良いんだけど、長すぎると読みにくいし、

省略しすぎると理解しにくい。
また、名前の付け方を決めておかないと他の人が理解できなくなってしまう・・。
そんな問題が起きないよう、命名規則について説明していくよ。

変数名の命名規則

  • PascalCase(パスカルケース)
    単語の最初を大文字にする命名規則です。クラス名などに使うことが多いです。
    PascalCase
  • camelCase(キャメルケース)
    先頭の単語だけ小文字にしてあとの単語の先頭は大文字にする命名規則です。
    camelCase
  • snake_case(スネークケース)
    単語と単語の間を”_”で繋げる命名規則です。全て大文字にし、値が変更されない定数として用いられることが多いです。
    SNAKE_CASE

以下は、ロブロックス公式がベストだと考える見解です。

  • クラスや列挙型のようなオブジェクトにはPascalCase名を使用します。
  • すべての Roblox API にPascalCase名を使用してください。camelCase APIはほとんど非推奨です。
  • ローカル変数、メンバー値、関数には、キャメルケース名を使用します。
  • ローカル定数 (値が変更されないと思われる変数)にはLOUD_SNAKE_CASE名を使用します。
  • 名前内の頭字語全体を大文字にしないでください。たとえば、aJsonVariableまたはMakeHttpCall と記述します。

良い変数名とは

変数名を見て、役割が分かるものが良いです。多少なら単語は長くても良いと考えます。
よくあるのは、カウント値を「cnt」にしがちなのですが、プレイヤーを数えることが役割だったら、「playerCnt」が良いと思います。これを気取って省略してしまうと「plyCnt」になります。一瞬、何の略だろうと思いませんか?

コメント

タイトルとURLをコピーしました