Freigeben über

Hinzufügen einer Anmerkung zu Strukturen und Klassen

  • Artikel

Sie können die Struktur und Klassenmember kommentieren, indem Sie Anmerkungen werden, die sich, wie Elementen angewendet werden, um an beliebigen Funktionsaufruf erfüllt sein bzw. Eintrag/Beenden arbeiten, die der übergeordneten Struktur als Parameter oder einen Ergebniswert beinhaltet.

Struktur- und Klassen-Anmerkungen

Anmerkung

Beschreibung

_Field_range_(low, high)

Das Feld ist im Bereich (einschließlich) von low in high. Entspricht _Satisfies_(_Curr_ >= low && _Curr_ <= high) auf das Objekt mit Anmerkungen, indem vor das entsprechende oder die auch für Nachbedingungen verwendet.

_Field_size_(size)

_Field_size_opt_(size)

_Field_size_bytes_(size)

_Field_size_bytes_opt_(size)

Ein Feld, das eine schreibbare Größe in Elementen oder (in Bytes) angegeben durch size verfügt.

_Field_size_part_(size, count)

_Field_size_part_opt_(size, count)

_Field_size_bytes_part_(size, count)

_Field_size_bytes_part_opt_(size, count)

Ein Feld, das eine schreibbare Größe in Elementen oder (in Bytes) angegeben durch size aufweist und count dieser Elemente (Bytes) die Lesbarkeit sind.

_Field_size_full_(size)

_Field_size_full_opt_(size)

_Field_size_bytes_full_(size)

_Field_size_bytes_full_opt_(size)

Ein Feld, das lesbare und schreibbare Größe in Elementen oder (in Bytes) angegeben durch size verfügt.

_Struct_size_bytes_(size)

Gilt Struktur oder Klassendeklaration zu. Gibt an, dass ein gültiges Objekt dieses Typs kann größer als der deklarierte Typ ist, mit der Anzahl der Bytes an, die von size angegeben werden. Beispiel:

typedef _Struct_size_bytes_(nSize)
struct MyStruct {
    size_t nSize;
    …
};

Die Puffergröße in Bytes eines Parameters pM vom Typ MyStruct * wird angenommen, um sein:

min(pM->nSize, sizeof(MyStruct))

Siehe auch

Referenz

Hinzufügen einer Anmerkung zu Funktionsparametern und Rückgabewerten

Hinzufügen einer Anmerkung zum Funktionsverhalten

Hinzufügen einer Anmerkung zum Sperrverhalten

Angeben, wann und wo eine Anmerkung gültig ist

Systeminterne Funktionen

Empfohlene Vorgehensweisen und Beispiele (SAL)

Konzepte

Einführung in SAL

Weitere Ressourcen

Verwenden von SAL-Anmerkungen zum Reduzieren von C/C++-Codefehlern