c++ - SAL 注释，使用哪一个？

Question

因此，我涉足了 C++ 的源代码注释，但发现有很多方法可以通向罗马，可以这么说。

例子：

__in

_In_

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

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

有没有一种微软的方式来做到这一点？

Answer 1

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

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

--

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

Answer 2

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