Using SAL Annotations to Reduce C/C++ Code Defects

SAL is the Microsoft source code annotation language. By using source code annotations, you can make the intent behind your code explicit. These annotations also enable automated static analysis tools to analyze your code more accurately, with significantly fewer false positives and false negatives.

The articles in this section of the documentation discuss aspects of SAL, provide reference for SAL syntax, and give examples of its use.

• Understanding SAL

  Provides information and examples that show the core SAL annotations.

• Annotating Function Parameters and Return Values

  Lists the SAL annotations for functions and function parameters.

• Annotating Function Behavior

  Lists the SAL annotations for functions and function behavior.

• Annotating Structs and Classes

  Lists the SAL annotations for structures and classes.

• Annotating Locking Behavior

  Explains how to use SAL annotations with lock mechanisms.

• Specifying When and Where an Annotation Applies

  Lists the SAL annotations that specify the condition or scope (placement) of other SAL annotations.

• Intrinsic Functions

  Lists the intrinsic SAL annotations.

• Best Practices and Examples

  Provides examples that show how to use SAL annotations. Also explains common pitfalls.

See Also

SAL 2.0 Annotations for Windows Drivers