구조체 및 클래스에 주석 지정

클래스 및 구조체 멤버는 고정 처럼 작동하는 주석을 사용하여 주석을 달 수 있습니다.-함수 시작/종료 바깥쪽 구조 매개 변수 또는 결과 값을 포함하는 함수 호출에서 true인 것으로 가정 됩니다.

구조체 및 클래스 주석

주석

설명

_Field_range_(low, high)

low 부터 high 까지 범위 (포함)에 포함된 필드 입니다. 사전 또는 사후 조건을 사용하여 지정된 개체에 _Satisfies_(_Curr_ >= low && _Curr_ <= high) 를 적용합니다.

_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 이해

기타 리소스

C/C++ 코드 오류를 줄이기 위한 SAL 주석 사용