ATSプラグインテンプレートの命名規則
概要
Rock On様により開発・頒布されている、各種のATSプラグイン・テンプレートプロジェクトのソースコードを読んで判明した限りの命名規則を、以下の表に掲載します。この記事はBVE Workshopの独自調査によるものです。Rock On様へ当記事についてのお問い合わせはなさらないでください。
用語説明
「キャメル」はキャメルケースの略で、単語間に区切り文字を使わず、二つ目以降の単語の頭文字を大文字にしたものです(例:camelCase)次で説明するパスカルケースとの区別を明確にするために、「ローワーキャメルケース」とも呼ばれます。全ての単語の頭文字を大文字にしたキャメルケースは「パスカルケース」や「アッパーキャメルケース」と呼ばれます(例:PascalCase)。「スネーク」はスネークケースの略で、単語の間をアンダースコアで連結します(例:snake_case)。スネークケースでは、文字は全て小文字もしくは大文字のいずれかです。「前置」はいわゆるハンガリアンケースを表し、1~2文字で表される属性情報を名前の冒頭に付加することを意味します。
BveAtsPluginTemplate
Github上で公開されている、シンプルなATSプラグインテンプレートです。こちらのテンプレートはBitbucketで公開されているテンプレートよりも新しいものです。このテンプレートでは、ファイル名はパスカルケース、関数名はパスカルケース、仮引数名はキャメルケースとなっています。
BveAtsPluginCsharpTemplate
Github上で公開されている、C#での記述を可能としたATSプラグインテンプレートです。命名規則はC#の標準的な命名規則である、Microsoft Naming Guidelinesに準じるとされています。
ATSプラグイン・テンプレート
Bitbucket上で公開されている、BVEのATSプラグイン・テンプレートプロジェクトです。命名規則は以下の通りです。
種類 | 命名規則 | 命名例 |
---|---|---|
ファイル | 小文字スネーク | ats_define.hpp |
ソリューション | キャメル | atsPlugin |
プロジェクト | キャメル | atsPlugin |
名前空間 | 小文字 | ats |
クラス | 小文字 | environment |
構造体 | 大文字スネーク、前置ST | ST_WIRING_DATA |
関数 | キャメル | atsLoad |
メンバ関数 | 小文字スネーク | get_instance |
ポインタ変数 | 小文字スネーク、前置p | m_p_instance |
グローバル変数 | 小文字スネーク・前置g | g_module_dir |
メンバ変数 | 小文字スネーク、前置m | m_p_instance |
その他の変数 | 小文字スネーク | ats_key_code |
定数 | 大文字スネーク | DLL_MAIN_HPP_INCLUDED |
マクロ | 大文字スネーク | SDELETE_ARRAY |
共用体 | 大文字スネーク、前置UN | UN_BUS_DATA |
共用体メンバ | 小文字、前置_ | _f64 |