SAL

微軟源代碼註釋語言

SAL,全名Microsoft source code annotation language,是微軟VC++ 2010及後續版本開始推出的一種是用宏定義語言,用來註釋函數的參數和返回值,由於這些宏最終都被預處理器處理掉了,所以不會對源代碼有任何影響。

目錄

簡介


這種註釋可以一方面讓使用者更加清楚API的使用方法,另一方面VS中的C++ 代碼分析器也會依靠這種宏註釋來分析代碼。
一般的函數:
使用SAL註釋后的函數:
1
2
3
4
void*memcpy(
void*dest,
constvoid*src,
size_tcount);
使用SAL註釋后的函數:
1
2
3
4
void*memcpy(
_Out_writes_bytes_all_(count)void*dest,
_In_reads_bytes_(count)constvoid*src,
size_tcount);
更多的 SAL 語法細節可以參考 MSDN 上的文檔。