Описание тега microsoft-sal

Microsoft SAL - это встроенный язык аннотаций API исходного уровня, обычно используемый для документирования WinAPI и различных проектов Microsoft.

Язык аннотации исходного кода Microsoft или SAL предоставляет встроенный метод для документирования функций API уровня источника с помощью макросов, предоставляемых sal.h заголовок.

Эти макросы используются для украшения аргументов функции и возвращаемых типов, обеспечивая указание различных свойств, таких как необязательность, нулевое завершение или размер буфера. Ниже приведен пример использования аннотаций SAL (взятых из MSDN):

void MyPaintingFunction(
    __in HWND hwndControl,      // An initialized read-only parameter.
    __in_opt HDC hdcOptional,   // An initialized read-only parameter
                                //  that might be NULL.
    __inout IPropertyStore *ppsStore  // An initialized parameter that
                                // may be freeely used and modified.
);

Начиная с Visual Studio 2008, макросы теперь стандартизированы для использования заглавных букв.