SAKUYA blog

表次郎のマクロの命名規則をヘルプに書いたので
こちらにも公開します。

本来最初に決めてユーザーの付ける名称とシステム側で付ける名前が
ぶつからないようにするために命名規則を設けると思います。
ただ、基本的にユーザーがいないので自分のなかでもうけたルール
だけで作ってましたがマクロについての要望がユーザー側から
あったことから命名規則を文面化しておこうかなという
気分になったので作ることにしました。
(2024/07/16記述、マクロ公開から数年たっている)

何がいいたいかというと命名規則といいながら一部結構な部分もある
こと。
includeファイルの関数については現状の命名はあまりよくないの
ですが使っていることもあって存在は残すのですが
今後は修正しようかなと考えているということです。

以上、注意ください。
あと、アドオンマクロで作者がマクロを作ってるわけですが
命名はかなり適当な面もあるので良い見本ではないので注意ください。


【システム側で付ける名称】
・命令関係は小文字で統一。（例外：RGB()）
　文字列と文字列の区切りをアンダーバー

・定数(表次郎的にはシステム側が事前に値を割り振った変数）では
　大文字で統一。（例外：true, false)
　文字列と文字列の区切りをアンダバー

・includeで取り込む関数：頭に"func_"を付けるようにして小文字で統一。
　文字列と文字列の区切りをアンダーバー
　※例外としてcalendr.hsh, tool.hshで定義している関数は除く
　　（利用している処理もあるのでファイルそのものは残す。）

・include内で使うグローバル変数は値をセットする関数名の頭に"g_"
　を付けて関数名の後ろにそれぞれの変数名を記述する。
　例：関数func_get_cell_range()で使うグローバール変数は
　g_func_get_cell_range_col1など

【ユーザー側推奨の名称】
・基本的には大文字小文字を混ぜた名前の場合は問題なしとする。
　※例外としてcalendr.hsh, tool.hshのincludeファイルで定義している
　　関数名は大文字小文字が混合したものになりますがルールなき
　　時代のもので
　　多分普通には名前がかぶることはないと思います。
　　今後はシステム側が用意するものとしては大文字小文字の混合
　　の名称は用意しないようにしたいと思っています。

・ローカル変数名：
　プレフィックス的な変数名。
　厳密に変数の頭に型を書いてほしいというわけではなく
　大文字小文字を混ぜた変数にしてもらうという意味です。

・グローバル変数名：
　小文字のみにする場合で頭に"g_"を付ける場合、"g_func_"とならな
　いようにする。

・定数は大文字で頭に"C_"を付けるようにする。

・関数の引数の名前はもし小文字だけにするなら頭に"i_"を付ける。
　　(大文字小文字を混ぜるなら問題なし）
　※作者は関数パラメータは小文字だけの略字にすることが多い
　ですが絶対に関数に名前を付けない自信があるからなので
　小文字だけにするなら"i_"を付けた方が無難です。
　　作者が良くパラメータに小文字だけで指定してる名前の例は
　　stringのデータならstrとか長さならlen、セルの位置はcol,rowなど
　　str、lenについては関数で発生しそうですが既にstring, lengthと
　　いう命令があるので短縮名の関数は用意するつもりはありません。