57、代码注解：隐藏已知或可接受结果的实用指南

代码注解：隐藏已知或可接受结果的实用指南

1. 代码注解基础

在代码分析过程中，我们常常会遇到一些已知或可接受的缺陷或编码规则违规情况。代码注解就像是我们处理这些情况的得力助手，它允许我们标记这些问题，避免在后续分析中重复审查，同时还能保留审查评论和分类信息。不过要注意，源文件注解并不适用于代码注释，像 MISRA C:2004 规则 2.2 和 2.3、MISRA C:2012 规则 3.1 和 3.2、MISRA - C++ 规则 2 - 7 - 1 以及 JSF++ 规则 127 和 133 这些规则是不能进行注解的。

2. 代码注解警告

当我们输入的代码注解不正确或者注解不再适用时，分析日志就会给出警告信息：“Warning: These Polyspace annotations do not apply to the current code”。这种警告可能由以下两种情况导致：
- 问题不再被检测到 ：由于代码修复或者分析配置的更改，某些问题可能不再被检测出来。例如，之前标记为红色或橙色的非法解引用指针检查（IDP），现在可能已经变为绿色，那么像 /* polyspace RTE:IDP [No action planned:Low] */ 这样的注解就不再适用了。
- 注解语法错误 ：以 polyspace 开头，后面跟着一个单词和冒号的注解，如 // polyspace Family : ，如果 Family 不是 Polyspace 结果类型（如