mylib

?? 영어 버전

CMAKE 어셈블리 시스템을 기반으로 한 프로젝트 템플릿 C ++ 언어

"mylib"을 당신의 이름으로 날려 버리고 변경하십시오.

또는 스크립트를 사용하여 프로젝트를 생성하십시오 : https://github.com/izvolov/mylib-gen

콘텐츠

1. 집회
   1. 세대
   2. 집회
2. 옵션
   1. mylib_coverage
   2. mylib_testing
   3. doxygen_output_language
3. 조립 목표
   1. 기본적으로
   2. mylib_library
   3. mylib-unit-tests
   4. 확인하다
   5. 적용 범위
   6. 의사
   7. 완드 박스
4. 예
5. 용법
   1. 설치를 통해
   2. 하위 모듈로
6. 도구
7. 보너스

집회

CMAKE 어셈블리 시스템의 다른 프로젝트와 마찬가지로이 프로젝트의 조립은 두 단계로 구성됩니다.

세대

cmake -S путь/к/исходникам -B путь/к/сборочной/директории [опции ...]

옵션에 대해 자세히 알아보십시오.

프로젝트 어셈블리

cmake --build путь/к/сборочной/директории [--target target]

조립 목표에 대해 자세히 알아보십시오.

옵션

mylib_coverage

cmake -S ... -B ... -DMYLIB_COVERAGE=ON [прочие опции ...]

coverage 의 목적을 포함하여 테스트로 코드를 측정 할 수 있습니다.

mylib_testing

cmake -S ... -B ... -DMYLIB_TESTING=OFF [прочие опции ...]

모듈 식 테스트의 어셈블리와 check 목표를 끄질 수있는 기회를 제공합니다. 결과적으로 테스트를 통해 코어 코팅으로 코드가 꺼집니다 (코팅 참조).

프로젝트가 add_subdirectory 명령을 사용하여 다른 프로젝트에 다른 프로젝트에 연결된 경우 테스트가 자동으로 연결되었습니다.

doxygen_output_language

cmake -S ... -B ... -DDOXYGEN_OUTPUT_LANGUAGE=English [прочие опции ...]

doc 목표에 의해 생성되는 문서 언어를 주어진 언어로 전환합니다. 접근 가능한 언어 목록은 Doxygen System 웹 사이트를 참조하십시오.

기본적으로 러시아어가 포함되어 있습니다.

조립 목표

기본적으로

cmake --build путь/к/сборочной/директории
cmake --build путь/к/сборочной/директории --target all

목표가 표시되지 않은 경우 ( all 목표와 동일) 가능한 모든 것을 수집하고 check 목표를 유발합니다.

mylib_library

cmake --build путь/к/сборочной/директории --target mylib_library

라이브러리에 의해 편집 됨 mylib_library . 기본적으로 포함됩니다.

mylib-unit-tests

cmake --build путь/к/сборочной/директории --target mylib-unit-tests

모듈 식 테스트를 컴파일합니다. 기본적으로 포함됩니다.

확인하다

cmake --build путь/к/сборочной/директории --target check

수집 된 모듈 식 테스트를 수집 한 (수집, 수집). 기본적으로 포함됩니다.

mylib-unit-tests 도 참조하십시오.

적용 범위

cmake --build путь/к/сборочной/директории --target coverage

GCOVR 프로그램을 사용하여 테스트를 통해 코드를 커버하기위한 고급 (아직 출시, 아직 실행) (시작) 모듈 식 테스트를 분석합니다.

목표는 포함 된 MYLIB_COVERAGE 옵션으로 만 사용할 수 있습니다.

check 도 참조하십시오.

의사

cmake --build путь/к/сборочной/директории --target doc

Doxygen 시스템을 사용하여 코드의 문서 생성을 고합니다.

완드 박스

cmake --build путь/к/сборочной/директории --target wandbox

이를 위해 완드 박스 서비스가 사용됩니다. 이 일을 남용하지 마십시오. 서버는 고무가 아닙니다.

예

코팅을 측정하여 부채 모드에서 프로젝트 조립

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DMYLIB_COVERAGE=ON
cmake --build путь/к/сборочной/директории --target coverage --parallel 16

예비 조립 및 테스트없이 프로젝트 설치

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DMYLIB_TESTING=OFF -DCMAKE_INSTALL_PREFIX=путь/к/установойной/директории
cmake --build путь/к/сборочной/директории --target install

주어진 컴파일러가있는 졸업 모드의 조립

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-8 -DCMAKE_PREFIX_PATH=путь/к/директории/куда/установлены/зависимости
cmake --build путь/к/сборочной/директории --parallel 4

영어로 된 문서 생성

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Release -DDOXYGEN_OUTPUT_LANGUAGE=English
cmake --build путь/к/сборочной/директории --target doc

용법

설치를 통해

모듈을 사용하는 옵션 중 하나는 시스템에 설치하는 것입니다.

cmake --build путь/к/сборочной/директории --target install

그 후, find_package 명령을 호출하는 다른 프로젝트는 Mylib:: 에서 모든 라이브러리를 사용할 수있는 기회를 얻습니다.

 find_package (Mylib 1.0 REQUIRED)

add_executable (some_executable some.cpp sources .cpp)
target_link_libraries (some_executable PRIVATE Mylib::library)

libmylib_library 라이브러리를 고수해야 할 때 Mylib::library 연결해야합니다. 헤드 라인이 충분하면 Mylib::headers 사용하는 것이 좋습니다.

하위 모듈로

이 프로젝트는 add_subdirectory 명령을 사용하여 하위 모듈로 다른 프로젝트에 연결할 수도 있습니다.

이 경우 Mylib::library 및 Mylib::headers 비슷한 방식으로 제공됩니다.

도구

1. Cmake 3.14

   CMAKE 3.14는 이전 버전에서 install(TARGETS ... EXPORT ...) 이전 버전에서 잘못 작동하기 때문에 기본 경로가 처방되지 않기 때문에 필요합니다.

2. DocTest 테스트 라이브러리

   테스트를 해제 할 수 있습니다 (테스트 참조).

3. 독사시

   문서가 생성 될 언어를 전환하려면 옵션 DOXYGEN_OUTPUT_LANGUAGE 제공됩니다.

4. 통역사 Jap Python 3

   온라인 샌드위치의 자동 생성.

보너스

CMAKE의 도움과 한 쌍의 좋은 도구를 사용하면 최소한의 신체 움직임으로 정적 분석을 제공 할 수 있습니다.

CPPCHECK

Cmake는 CPPCheck의 정적 분석을 지원했습니다.

이렇게하려면 CMAKE_CXX_CPPCHECK 옵션을 사용하십시오.

cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug -DCMAKE_CXX_CPPCHECK= " cppcheck;--enable=all;-Iпуть/к/исходникам/include "

그 후, 정적 분석은 소스의 편집 및 교차 구성 동안 매번 자동으로 시작됩니다. 추가 작업을 수행 할 필요는 없습니다.

그 소리

훌륭한 scan-build 도구를 사용하여 두 가지 점수로 정적 분석을 시작할 수도 있습니다.

scan-build cmake -S путь/к/исходникам -B путь/к/сборочной/директории -DCMAKE_BUILD_TYPE=Debug
scan-build cmake --build путь/к/сборочной/директории

여기서는 CPPCheck의 경우와 달리 매번 scan-build 통해 어셈블리를 실행해야합니다.