ywork2020.com

Title

命名規則で、プログラムを解りやすくすることが出来る

命名規則とは

プログラミングにおいて、ソースコードの可読性や視認性の向上、プログラミング効率およびメンテナンス性の改善などを目的としています。
javascriptを一旦離れての話になりますが、他の言語では変数にjavascriptよりも厳密なデータ型というのがあります。例えば 文字列型 = String , 整数型 = Integer , 日付型 = Date ... という具合です。

Basic言語で変数を定義するコードを書く時、一例ですが以下の様な書き方があります。(絶対ではなく個人、チームや会社で決めるもの)
Dim strMojiretsu AS String
Dim intSeisuu AS Integer
Dim datHiduke AS Date

定数の定義なら以下の様な書き方があります。
Const TEISUU As String = "任意の文字列"
Const cstTeisuu As String = "任意の文字列"

変数にデータ型が存在する言語は、その型以外のデータを入れようとするとエラーになります。
また、全ての型を入れられる便利な Variant型 も存在しますが、メモリーを多く消費します。 定数なら一度、値を決めてしまえば変更することはありませんが、変数は値が変化するものですのでデータ型の不一致や変換処理を間違えてエラー連発で進めなくなるなんてこともあります。 その様な理由から変数にはデータ型が分るように識別子として3字程度の小文字を頭につけて解りやすくするという工夫をするのが一般的なコードの書き方になります。

javascriptやPHPの話に戻りますが、この言語はデータ型は存在するけども変数を使う上でそんなに意識しなくてもよい仕様になっています。
文字値を入れていた変数に数値を入れなおすこともできます。ただし、演算処理などを行うときには意識する必要があるのでそこだけは注意していただきたいと思います。

基本的な表記法

言語、個人、開発チーム、会社の仕様書などで取り決めをするものなので特にはありませんが、○○ケースなどの呼び方で広く使われている一般的な表記法は多数存在します。

YWORKの命名規則 サンプル

YWORK 命名規則の一例

これの命名には...名前を付ける時に頭文字(2~3字)に、これを付けてください(Nameのところが任意で付ける名前)
タグ要素(Element)elmName
アイディ属性(Identification)idName (例:idP1,idDiv1.idTable1)
クラス属性(Class)clsName (例:clsP1,clsDiv1.clsTable1)
ネーム属性(name)namName (例:namP1,namDiv1.namTable1)
イベント(Event)evtName (例:evtOnClick1,evtMouseOver1)
オブジェクト(Object)objName
変数(Variable)varName (例:varHensuu1)
定数(Constant)cstName
配列(Array)arrName