이 페이지는 기계 번역을 사용하여 번역되었습니다. 영어 원문을 보려면 여기를 클릭하십시오.

Polyspace as You Code 플러그인에서 주석 자동 완성 기능을 위해 정당화 사유 카탈로그 사용

분석을 실행한 후, 알려진 결함이나 허용 가능한 결함, 또는 코딩 규칙 편차를 억제할 수 있습니다. 이를 위해 코드 주석을 추가하여 해당 문제가 검토되었으며 수정되지 않을 것임을 표시하면 됩니다.

조직에서 알려진 결함이나 허용 가능한 결함, 코딩 표준 편차를 정당화 사유에 사용하는 미리 정의된 주석 세트가 있는 경우, 이러한 주석을 정당화 사유 카탈로그에 저장할 수 있습니다. 여기서 각 결함 또는 코딩 규칙 편차에 하나 이상의 주석을 연결할 수 있습니다. 그런 다음 이 카탈로그를 Polyspace® as You Code Visual Studio Code 확장 프로그램 또는 Eclipse™ 플러그인에 전달하고, 코드 주석을 달 때 미리 정의된 주석을 사용하여 코드 주석 주석을 자동 완성할 수 있습니다.

Polyspace annotation autocomplete

이 설정에서 카탈로그 파일의 경로를 지정하여 카탈로그를 Polyspace as You Code에게 전달합니다:

정당화 사유 카탈로그 생성 및 편집

정당화 사유 카탈로그는 Polyspace 코드 주석 구문을 사용하는 JSON 파일입니다. 구문 세부 사항은 Annotation Syntax Details (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를 주석 처리할 때도 이 주석이 자동 완성으로 제공됩니다.

참고 항목

외부 웹사이트