mylib

？英語版本

基於C ++語言CMAKE組裝系統的項目模板

將“ 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檢驗
   4. 查看
   5. 覆蓋範圍
   6. Doc
   7. Wandbox
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系統網站。

默認情況下，包括俄羅斯人。

組裝目標

默認情況下

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

如果未指示目標（相當於all目標），請收集所有可能的一切，也會導致check目標。

mylib_library

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

由庫mylib_library編譯。默認包含。

mylib-unit檢驗

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

編譯模塊化測試。默認包含。

查看

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

符合收集的（收集）模塊化測試。默認包含。

另請參見mylib-unit-tests 。

覆蓋範圍

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

分析使用GCOVR程序進行測試覆蓋代碼的模塊化測試高級分析（啟動）。

該目標只有隨附的MYLIB_COVERAGE選項可用。

另請check 。

Doc

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

使用doxygen系統來鍵入代碼的文檔。

Wandbox

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

為此，使用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. 醫生測試庫

   可以關閉測試（請參閱測試）。

3. doxygen

   為了切換將生成文檔的語言，提供了選項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來運行組件。