Luaのコーディング規約について


Luaのサンプルコードを見るとかなり自由に書かれています。

コーディング規約について調べてみました。

 

コーディング規約

コーディングが規約がありました。

まだ最近に更新されたようです。

http://lua-users.org/wiki/LuaStyleGuide

 

中身を簡単に見ていきます。

インデント

インデントはスペース2つ分で行います。

ネーミングについて

変数名

変数名は一般的に小文字で短くします。(color)

Beginning Lua Programmingでは、キャメルケース(CamelCase)を教育的な理由で使っています。

真偽型はisをつけるとわかりやすくなります。

例: is_directory

関数名

複数の言葉の組み合わせはすべて小文字で書きます。

例: getmetatable

ただし、print_tableのようにアンダースコアを使ってもOK。

定数名

大文字でアンダースコアを使います。

例:ALL_CAPS

 

モジュール・パッケージ名

すべて小文字にします。

 

クラス名

キャメルケースを使います。

 

スコープ

できる限りローカルで宣言します。

do-endを利用してスコープを限定すると便利です。

 

コメント

–の後にスペースを1つ入れます。

return nil — not found (suggested)

return nil — not found (discouraged)

 

最後に

他にもいくつかありますが、ざっと見た感じで必要そうなところを取り上げました。

Luaのサンプルコードは、ひどいものだと変数名がa1、a2のような記述もあります。(大抵古いソースコードですが)

またCorona SDKのドキュメントでも、ページによっては書き方が少し違ったりしています。

Luaは本体が小さい言語なので、イテレータなどを自分で実装することも多く、スクリプト言語でも記述が長くなりますので、できるだけ綺麗に書きたいですね。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です