문서화 규칙이란 무엇인가요?

수정일 수, 27 5월 시간: 8:09 AM

문서화 규칙은, 정적분석도구에서 위배 여부를 판단할 수 없는 규칙입니다.

따라서 사용자가 해당 규칙을 준수했는지 여부와 상관없이, 해당 위배는 항상 표시됩니다.


해당 위배가 항상 표시되는것은 아래의 두가지 목적을 갖습니다.

1. 해당 규칙에 맞게 문서화 해야한다는 내용을 사용자(개발자)에게 상기시키기 위한 목적

2. 실사 과정에서 문서화규칙의 준수여부를 확인해야한다는 내용을 검사관(auditor)에게 상기시키기 위한 목적


따라서 해당 위배는 해결할 수 없으며, 해당 규칙 설명의 내용처럼 문서화 해두고

위배 상태를 Suppressed(Document) 상태로 변경하여 해당 위배를 무시할 수 있습니다.

이후 실사 등의 과정에서 오디터에게 문서화된 자료를 제출하고 소명해야 합니다.


STATIC 사용 설명서에서도 위 내용에 대한 설명을 확인할 수 있습니다.

(아래 주소에 사용하시는 STATIC 서버의 IP 주소와 포트번호를 반영하고 접속하면 확인할 수 있습니다.)

https://STATIC서버IP주소:포트번호/help/help-content/2-9-1


위 사용 설명서의 내용은 아래와 같습니다.


문서화 규칙이란?

문서화 규칙 위배 항목

문서화 규칙은 정적 분석 도구로 위배 여부를 자동 판단할 수 없는 항목입니다.
따라서 사용자가 해당 규칙을 준수했는지 여부와 관계없이, 항상 위배 항목으로 표시됩니다.
해당 위배 검출은 정상적인 현상으로, 규칙 설명에 따라 문서화한 후 Suppressed(Document) 상태로 변경하여 해당 위배를 무시할 수 있습니다.

이러한 위배 항목이 표시되는 이유는 다음과 같은 두 가지 목적을 갖습니다.

  1. 개발자에게 문서화 필요성을 상기시키기 위한 목적
    → 해당 규칙에 맞게 문서화가 이루어져야 함을 사용자(개발자)에게 안내합니다.

  2. 검사관에게 확인 필요성을 상기시키기 위한 목적
    → 실사 과정에서 문서화 규칙 준수 여부를 확인해야 함을 명시합니다.

문서화 규칙 목록

STATIC 에서 제공하는 문서화 규칙 목록은 다음과 같습니다.

문서화 규칙 목록
MISRA_01_01
MISRA_01_02
MISRA_01_03
MISRA_01_04
MISRA_01_05
MISRA_03_01
MISRA_03_02
MISRA_03_03
MISRA_03_04
MISRA_03_05
MISRA_03_06
MISRA_18_02
MISRA_18_03
MISRA_CPP_00_04_01
MISRA_CPP_00_04_02
MISRA_CPP_00_04_03
MISRA_CPP_01_00_01
MISRA_CPP_01_00_02
MISRA_CPP_01_00_03
MISRA_CPP_02_02_01
MISRA_CPP_07_04_01
MISRA_CPP_09_06_01
MISRA_CPP_15_00_01
MISRA_CPP_16_06_01
MISRA_CPP_17_00_04
MISRA_C_2012_DIR_01_01
MISRA_C_2012_DIR_02_01
MISRA_C_2012_DIR_03_01
MISRA_C_2012_DIR_04_02
MISRA_C_2012_01_01
MISRA_C_2023_DIR_01_01
MISRA_C_2023_DIR_02_01
MISRA_C_2023_DIR_03_01
MISRA_C_2023_DIR_04_02
MISRA_C_2023_01_01

아티클이 유용했나요?

훌륭합니다!

피드백을 제공해 주셔서 감사합니다.

도움이 되지 못해 죄송합니다!

피드백을 제공해 주셔서 감사합니다.

아티클을 개선할 수 있는 방법을 알려주세요!

최소 하나의 이유를 선택하세요
CAPTCHA 확인이 필요합니다.

피드백 전송

소중한 의견을 수렴하여 아티클을 개선하도록 노력하겠습니다.