AliceScriptのコーディング規約

この記事では、AliceScriptでプログラミングを行う際に参考となるコーディング規約を紹介します。

コーディング規約は、よりよいプログラムを作るために推奨されるルールのことです。コーディング規約には、次の目的があります。

• コードの見た目が統一されるため、コードを読むときに、内容が理解しやすくなります。
• コードの複製、変更、および保守が容易になります。

名前付け規則

ÅliceScriptコードを記述するときに考慮するべき名前付け規則がいくつかあります。

パスカルケース

パスカルケースとは、語間の空白を取り除いて連結し、構成語の先頭を大文字にする記法を指します。AliceScriptでは、classの名前付けにパスカルケースを使用することを推奨します。

class TestClass
{

}

インターフェースに名前をつけるときには、パスカルケースを使用するだけでなく、その名前の先頭にIを付けます。これにより、コードの読み手にそれがinterfaceであることが伝わります。

interface ITestInterface
{

}

定数

定数名はすべて大文字で定義し、区切り文字はアンダースコアで記述します。これにより、定義部を確認しなくても定数であることが一目でわかります。

const VERSION = "1.0";
const FULL_VERSION = "1.0(falcon)";

コメント規則

• コメントは、行の末尾ではなく別の行に喜寿るします。
• コメントのテキストが英文の場合、大文字で開始します。
• コメントのテキストは。やピリオドで終了します。
• 次の例のように、コメントデリミタ(//)とテキストの間に空白を一つ挿入します。

// これはコメントです。

コーディングベストプラクティス

不要な比較をスキップして比較のパフォーマンスを向上させるには、&の代わりに&&演算子を、|の代わりに||演算子を使用します。