5-1. RobloxにおけるLuaのスタイルガイド
RobloxにおけるLuaスタイルガイド
コーディングでは、特にチーム開発などにおいて可読性をあげるためにも、統一されたスタイルでコードが書かれていることも重要となります。この統一性は、自分のコードベースとしてだけでなく、チームとして統一されていることがチーム開発の場合には重要となります。
Roblox Lua Style Guide
以下でRobloxでのLuaコーディングに対するスタイルガイドが記されています。指針に記されている通り、これが正しいというわけではなく、統一するための指針となります。
以下が主だったポイントです。
- タブを使用してインデントする
- 行は100列以内に収める
- 行末に余分なスペースは残さない
- 縦方向の整列は行わない
- 1行に1文を意識し、関数の中身などは別の行から書く
- キーワードの周りやカンマのあとにスペースを入れる
- table等の開始中括弧などを単一行で使うことは避ける
- 長い式、table定義などでは改行して見やすくする
- 文字列リテラルはダブルクォーテーションを使用する
- tableでindexと辞書が混ざったような使い方はしない
- 関数に渡す引数は少なくする、2つ程度以下に収める
- コメントは、何をしているかではなく、なんの意図かを記述する
- グローバル変数よりローカル変数を優先する
- 変数や関数にはキャメルケース、タイプ等にはパスカルケースを使用する
- 文をファイルの上部に宣言し、アルファベット順に並べる
上述もした通り必ず守らねばならないものではありませんが、これらを意識することで共通のルールにより、可読性やメンテナンス性の高い一貫したコードスタイルが維持されます。可能な範囲で合わせていきましょう。