c++ - 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

是否有一种-microsoft 方式来做到这一点？

Answer 1

从 Windows 8¹ 开始，Microsoft 引入了新的 SAL 标准 ( SAL 2.0 )。 SAL 2.0 使用单下划线风格的注解，如_In_opt_ among others .因此，对于所有新代码，最佳实践是遵循 SAL 2.0 风格，如 slides来自 Microsoft 展览。

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

--

¹ - SAL 2.0 实际上从 2010 年就已经存在(查看链接演示文稿中的日期)，但据我所知，直到 Windows 8 才获得外部官方支持。