SAL注释，哪一个使用？

Question

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

示例：

__in

_In_

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

• VS2005 SAL Annotations
• VS2010 Using Annotations to Reduce C/C++ Code Defects
• VS2012 Using SAL Annotations to Reduce C/C++ Code Defects

有一个 - 微软方式吗？

Answer 1

Microsoft从Windows 8 ¹ 开始引入了新的SAL标准（SAL 2.0）。 SAL 2.0使用单个下划线样式的注释，例如_In_opt_ among others。因此，对于所有新代码，最佳做法是遵循SAL 2.0样式，如Microsoft展示的slides。

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

-

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

Answer 2

可能不是，因为SAL注释是一种元语言，可以帮助静态分析工具在编译时检查错误，我认为它可能是编译器依赖的（至少在某种程度上复杂的检查） 所以你可能没有单向的方式，但从一个到另一个的过渡并不太复杂