Hinzufügen einer Anmerkung zu Strukturen und Klassen
Sie können Struktur und Klassenmember kommentieren, indem Sie Anmerkungen verwenden, die wirkt, wie Element-sie angenommen wird, dass an beliebigen Funktionsaufruf erfüllt sein bzw. Eintrag/Beenden arbeiten, die die einschließende Struktur als Parameter oder ein Ergebniswert einschließt.
Struktur- und Klassen-Anmerkungen
Anmerkung |
Beschreibung |
---|---|
_Field_range_(low, high) |
Das Feld ist im Bereich (einschließlich) von low zu high.Entspricht _Satisfies_(_Curr_ >= low && _Curr_ <= high) angewendet auf das - Objekt mit Anmerkungen, indem sie vor das entsprechende oder die Vor- als 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 übergeordneten oder (in Bytes) wie durch size angegeben hat. |
_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 übergeordneten oder (in Bytes) wie durch size angegeben ist und count dieser Elemente (Bytes) die lesbar 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 übergeordneten oder (in Bytes) wie durch size angegeben hat. |
_Struct_size_bytes_(size) |
Gilt für Struktur oder Klassendeklaration zu.Gibt an, dass ein gültiges Objekt dieses Typs möglicherweise größer als der deklarierten Typ ist, mit der Anzahl der Bytes an, die von size angegeben werden.Beispiel:
Die Puffergröße in Bytes eines Parameters pM des Typs MyStruct * wird dann verwendet, um zu sein:
|
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
Empfohlene Vorgehensweisen und Beispiele (SAL)
Konzepte
Weitere Ressourcen
Verwenden von SAL-Anmerkungen zum Reduzieren von C/C++-Codefehlern