27.1. コーディング規約

表 27.1. クラスとマクロの命名規則

クラス	解説
SFA`Name`	SophiaFramework UNIVERSE の内部クラスです。
SFB`Name`	SophiaFramework UNIVERSE の BREW インターフェースラッパークラスです。
SFC`Name`	SophiaFramework UNIVERSE のコアクラスです。
SFD`Name`	SophiaFramework UNIVERSE のデバッグ用クラスです。
SFH`Name`	予約されています。( 未使用 )
SFI`Name`	予約されています。( 未使用 )
SFM`Name`	SophiaFramework UNIVERSE のマクロです。
SFP`Name`	予約されています。( 未使用 )
SFR`Name`	SophiaFramework UNIVERSE の SFR レスポンダシステム（旧レスポンダシステム）のクラスです。（SophiaFramework UNIVERSE 6.0 以降廃止予定）
SFT`Name`	予約されています。( 未使用 )
SFU`Name`	予約されています。(SophiaFramework UNIVERSE 旧バージョンのユーティリティクラス )
SFX`Name`	SophiaFramework UNIVERSE のユーティリティクラスです。
SFY`Name`	SophiaFramework UNIVERSE の SFY レスポンダシステム（新レスポンダシステム）のクラスです。
SFZ`Name`	SophiaFramework UNIVERSE の SFZ レスポンダシステム（新レスポンダシステム）のクラスです。
SFW`Name`	予約されています。( 未使用 )

表 27.2. 関数ポインタの命名規則

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

ソースコードの可読性のため、関数により変更される引数があるときは、引数は参照渡しではなくポインタ渡しとなります。

例 27.1. SFXRingBuffer::Read()のプロトタイプ

SFCError Read(SFXBufferPtr buffer);

	注意
	読み込みに成功したかどうかを戻り値で返し、読み込んだデータは引数の buffer に格納されます。

関数に定数オブジェクトを渡すには、ポインタではなく const 参照にします。

例 27.2. SFXRingBuffer::Write()のプロトタイプ

SFCError Write(SFXBufferConstRef buffer);

Set 関数を呼び出すと、設定されていた値は失われます。

Get 関数を呼び出しても、設定されていた値は失われません。