SAL注释,哪一个使用？

Question

所以我已经将我的脚趾浸入C++的源代码注释中,但发现罗马有很多方法,可以这么说.

例子:

__in

_In_

[Pre(FormatString(Style="printf")] LPCSTR format

• VS2005 SAL注释
• VS2010使用注释来减少C/C++代码缺陷
• VS2012使用SAL注释来减少C/C++代码缺陷

是否有一种 -微软的方式来做到这一点？

Answer 1

微软已经推出了新的SAL标准(SAL 2.0)开始使用Windows 8 ¹.SAL 2.0使用单个下划线样式的注释,例如_In_opt_ 其他.因此,对于所有新代码,最好的做法是遵循SAL 2.0样式,如Microsoft的幻灯片所示.

对于旧代码,"保持一致"的一般规则似乎是最好的方法,但如果您想要更新所有注释,请再次遵循SAL 2.0样式.

-

¹ - SAL 2.0自2010年以来实际上已经存在(检查链接演示文稿的日期),但据我所知,它在Windows 8之前尚未得到外部官方支持.