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来运行组件。