コーディングにおける記法

HTML, CSS , PHP, JavaScript, C# など、コーディングの際に、見やすくするために命名規則というものが重視される。

その中でどういった書き方をするかという記法といものがある。

ハンガリアン記法、キャメルケース、スネークケース、ハイフン が主な記法となる。

ハンガリアン記法

先頭文字に型を書く。

bOpenFlag : boolean型のフラグ変数

iCounter : int型のカウンター

といった具合に、先頭に型を持ってくる。

昔、型が違うとエラーで落ちていた言語を使っていた時代に使われるようになった模様。
昨今では、型が違っても問題ない言語が増えたことや、型が厳しいC#などでも開発環境の進化によりエディタの方で型が判断出来たりエラー検知してくれるので、あまりお目にかかることは無くなった。

キャメルケース

openFlag と書くローワーキャメルケースとOpenFlag と先頭文字も大文字で書くアッパーキャメルケースがある。

文字の接続部を大文字にすることで、凸凹してラクダのこぶっぽいからキャメルケースとなったらしい。

変数ではローワーキャメルケース、クラス名や関数ではアッパーキャメルケースなどと使われる。
ただし、上記の限りではなく関数名もローワーキャメルケースで書くなど、ルールは言語や環境による。

スネークケース

open_flag とアンダースコアで繋げて書く。

見た目が蛇(snake)っぽいのが由来らしい。

タケノコ vs キノコ のように、よくキャメルケースと争われている。
個人的にはあまり使わない気がするが、データベースのカラム名やテーブル名はすべてスネークケースで書いている。

ハイフン

open-flag のようにハイフンで区切る。

これはHTMLやCSSでよくつかわれているイメージがある。

プログラム言語だと‐はマイナスとして扱われるので、あまりお見掛けしない。

 

まとめ

郷に入っては郷に従えということわざがあるが、それがまさに正解だと思う。

新規で作っていくなら、ルールを好きなように決めれるが、既にあるシステムを触るなら空気を読んで同じ記法にするべき。

色々、個人のルールや書き方、こうすべきなどの議論はあるが、既にあるシステムのルールを無視する奴は大抵お仕事できない人です。

Leave a Reply

Your email address will not be published.

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>