使用申述目录在 Polyspace as You Code 插件中自动填写注解

运行分析后，您可以通过添加代码注解来抑制已知或可接受的缺陷和编码规则偏差，以指示问题已经过审查并且不会进行修复。

如果您所在组织有一组预定义的注释可用于申述已知或可接受的缺陷和编码规则偏差，则您可以将这些注释存储在申述目录中，您可以在该目录中将一个或多个注释与每个缺陷或编码规则偏差关联。然后，您可以将该目录传递到 Polyspace® as You Code Visual Studio Code 扩展或 Eclipse™ 插件，并在为代码添加注解时使用预定义注释自动填写代码注解的注释。

Polyspace annotation autocomplete

您可以通过在以下设置中指定目录文件的路径，将目录传递到 Polyspace as You Code：

创建和编辑申述目录

申述目录是使用 Polyspace 代码注解语法的 JSON 文件。有关此语法的详细信息，请参阅注解语法详细信息 (Polyspace Bug Finder)。要创建目录，请将 justification_catalog.json 复制到文本编辑器并将其另存为采用 UTF-8 编码的 JSON 文件。

 justification_catalog.json

JSON 结构体由一个 justifications 数组组成，该数组包含一个对象集合，每个对象至少包含三个键-值对组。一个对象表示一个结果以及要与该结果关联的注释。

{
    "justifications":[
        {
            "family": "familyValue",
            "acronym": "acronymValue",
            "comment":[
                "autocomplete comment for family:acronym result",
                "some other autocomplete comment for the same result"
            ]
        }
    ]
}

  • 为 family 键指定 Polyspace 结果族别值。

  • 为 acronym 键指定 Polyspace 结果名称值。

  • 为 comment 键指定注释，以将该注释与具有您在其他键-值对组中指定的族别和结果名称的 Polyspace 结果关联。

    要将其他注释与结果关联，请在表示该检查结果的对象中添加更多注释键-值对组。

例如，在文件 justification_catalog.json 中，当您为缺陷 METHOD_NOT_CONST 键入注解时，注释 "This is my preset justification" 和 "Another justification for same defect" 可用于自动填写注解。因为注释 "Rule wildcard justification applies to all defects" 适用于所有缺陷，因此当您为 METHOD_NOT_CONST 添加注解时，该注释也可用于自动填写注解。

另请参阅

外部网站