2. coding style guideline / static analysis

happy_quokka·2023년 11월 27일
0

etc

목록 보기
1/1

1. naming convention

  • 어떤 항목이 들어가는지 나눈다
  • 대부분의 개발 문서는 md 파일로 작성된다

clang 2가지 기능 (clang을 깔면 사용할 수 있다)

  • 포멧
  • tidy

clang-format

  • 포멧팅을 맞춰주는 것
  • 줄 간격, 화이트 스페이스, 헤더 순서 등을 자동으로 맞춰주는 것 = auto formatting
  • 단축키 ctrl-shift-I
  • 프로젝트 최상위단에 .clang-format을 만들고 원하는 내용을 기술하면 자동으로 이것에 맞게 정렬을 해준다

  • clangformat 사이트에서 볼수 있다
  • 터미널에서 clang-format -style=llvm -dump-config > 원하는 파일로 원하는 타입을 지정하면 알아서 만들어 준일 -> 이걸로 포멧팅(단축키 누르면?)
  • 그리고 몇개의 option을 바꿔서 사용하면 된다

세팅하는 법

  • convention과 다른 경우 알려준다
  • clang-tidy 기능 사용

clang-tidy

  • 분석 도구

  • 정적 검증

  • 최상위단에 .clang-tidy를 만들어서 옵션을 만들어줄수 있다 -> 아래에 다 자동으로 적용이 된다

  • CheckOptions

    • naming convention을 적용할 수 있다.
    • 원하는 key에 type 지정
    • suffix : 뒤에 붙일거
    • prefix : 앞에 붙일거
  • 옵션에서 필수적인 부분만 사용하고자 한다

  • 옵션에 대한 리스트들을 그룹화시켜져있다.

  • Checks에 옵션 추가 : 여기에 그룹화된 것들을 가지고 온다

  • 스크립트 파일을 만들어서 사용한다
  • 사용하는 프로젝트 폴더에 제공해주신것 넣고
  • 검증을 하고 싶을 때 마다 ./apply_static_analysis.sh를 터미널에서 실행시킨다
  • clang-analyzer
    cppcoreguidelines
    performance
    protability
    readability
    정도는 적용을 하는 것을 추천

0개의 댓글