構造体とクラスに注釈を付ける

オブジェクト不変条件がすべての関数呼び出しに当てはまると予想される機能やエントリと終了パラメーターまたは戻り値として囲む構造を含める機能するように注釈を使用すると、構造体およびクラス メンバーに注釈を付けることができます。

構造体とクラスの注釈

注釈	説明
_Field_range_(low, high)	フィールドは low から highの範囲 (包括) です。_Satisfies_(_Curr_ >= low && _Curr_ <= high) への等価、コメントされたオブジェクトに適したまたは Post 条件を使用することによって発生します。
_Field_size_(size) _Field_size_opt_(size) _Field_size_bytes_(size) _Field_size_bytes_opt_(size)	要素 (またはバイト) で sizeで指定されたとおりに書き込み可能サイズを持つフィールド。
_Field_size_part_(size, count) _Field_size_part_opt_(size, count) _Field_size_bytes_part_(size, count) _Field_size_bytes_part_opt_(size, count)	要素 (またはバイト) で sizeで指定されたとおりに書き込み可能サイズがあるフィールド、読みやすい要素 (バイト) count です。
_Field_size_full_(size) _Field_size_full_opt_(size) _Field_size_bytes_full_(size) _Field_size_bytes_full_opt_(size)	要素 (またはバイト) で sizeで指定されたとおりに読みやすい形式で書き込み可能サイズを持つフィールド。
_Struct_size_bytes_(size)	構造体またはクラス宣言に適用されます。その型の有効なオブジェクトが宣言型よりも大きい場合がある sizeで指定されたバイト数とことを示します。たとえば、次のようになります。 typedef _Struct_size_bytes_(nSize) struct MyStruct { size_t nSize; … }; MyStruct * 型のパラメーター pM のバイトのバッファー サイズは次のようになるように、取得: min(pM->nSize, sizeof(MyStruct))

参照

関連項目

関数パラメーターおよび戻り値の注釈設定

関数の動作に注釈を付ける

ロック動作に注釈を付ける

注釈を適用するタイミングと場所の指定

組み込み関数

ベスト プラクティスと例 (SAL)

概念

SAL について

その他の技術情報

SAL 注釈を使って C/C++ のコード障害を減らす方法