29.1. コーディング規約

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

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

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

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

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

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

SFCError Read(SFXBufferPtr buffer);

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

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

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

SFCError Write(SFXBufferConstRef buffer);

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

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