2.4. コーディング規約

SophiaFramework で使われているコーディング規約について説明します。

SophiaFramework 2.1 では、クラスや関数に対して次のような命名規則を採用しています。

SFA`Name`	SophiaFramework の内部で使われているクラスです。
SFB`Name`	BREW API のラッパークラス
SFC`Name`	コアクラス
SFM`Name`	マクロ
SFR`Name`	レスポンダクラスまたは関数
SFT`Name`	テンプレートクラスまたは関数
SFU`Name`	ユーティリティクラスまたは関数

コールバック関数については次の命名規則を採用しています。

`Name`MPP	メンバ関数へのポインタ (MPP = Member Procedure Pointer)
`Name`SPP	静的関数へのポインタ (SPP = Static Procedure Pointer)

関数により変更される引数がある場合、その引数は参照渡しではなくポインタ渡しにしています。コードを読む場合に、関数により引数の値が変更されることをすぐに認識できるようにするためです。

たとえば、SFUGraphics::GetBackground() のプロトタイプは次のようになっており、ポインタ渡しで値を受け取ります。

Void GetBackground(SFUColorPtr pColor);

一方、関数に定数オブジェクトを渡す場合は、ポインタではなく const 参照で渡します。たとえば、SFUGraphics::DrawTriangle() のプロトタイプは次のようになっています。

Void DrawTriangle(ConstSFUTriangleRef tri);