はじめてのJScript+WSH その１０ 命名規則やコード規約
はじめに
プログラミングをする際に、命名規則やコード規約を定義する場合があります。どんな考え方があるか調べてみました。
ハンガリアン記法
ざっくり説明すると、変数の頭に型や特性を記載する手法です。
①下記のようにプレフィックス帳が数値か文字列か分かるようにしたり
numPrefix = 24
strPrefix = "24"
②下記のようにipv4かipv6かaddressの特性が分かるようにしたり
v4Address
v6Address
できます。
調べると変数の型を接頭につけるハンガリアン（上記①）は良くないとされる記事が多々見られますが、この記事の用途では使った方が良いのではと考えています。理由は下記の通り。
・JScriptが動的型付け言語のため
・メモ帳で編集することが多いため
・プログラミングに不慣れな読者が想定されるため（私含め）
変数等の綴り方
複数の英単語を直接組み合わせる際に、各単語の先頭を大文字にして区切りをわかりやすくします。
JScriptではアッパーキャメルとローワーキャメルを使うのがよさそうでした。
アッパーキャメルケース（パスカルケース）
すべて単語を大文字で書き始める
例）GetInputReader
クラスを使うときに使用されます。
ローワーキャメルケース（キャメルケース）
先頭の単語のみ小文字で書き始める
例）getInputReader
スネークケース
各単語をアンダースコア(_)で繋げる
例）get_input_reader
あまり使われない印象です。DBでは見かける印象。
チェインケース（ケバブケース）
各単語をハイフン(-)で繋げる
例）get-input-reader
プログラミングではあまり見ないですが、htmlでは見かけます。
コンスタントケース
すべて大文字で記載する
例）DEBUG_FLAG
定数を使うときに使用されます。
マジックナンバー
書いた本人以外意味が自明ではない数字のことです。
これは避けるか、コメントを付けた方がよさそうです。
var price = 100;
var priceIncludingTax = 100 * 1.10; // 税率は10%とする↑より↓の方が分かりやすい。（長いコードになると実感できると思います）
var price = 100;
var tax = 1.10;
var priceIncludingTax = price * tax;変数や関数に使う単語
関数の最初は動詞から始めがちです。get,make,write,read,appendなど。
また、変数名などに使用する名詞はわかりやすいものや、省略しないのが望ましいとされています。（〇：message、△：msg）
おわりに
様々な宗派がありそうで難しそうでした。
参考
次の記事
前の記事
この記事が気に入ったらサポートをしてみませんか？