CMake 注释

CMake 是一个跨平台的开源构建系统，可用于自动生成 Makefile、Ninja、Visual Studio 等构建文件。本文将介绍 CMake 中的注释功能。

行注释

CMake 中的行注释以 "#" 开头。行注释将从 # 到行尾之间的所有字符都视为注释。

示例：

# This is a comment

set(SOME_VARIABLE "hello world")  # This is another comment

块注释

CMake 中的块注释以 "#" 和 "{" 开始，并以 "}" 结束。在块注释中，# 号后的任何字符都被视为注释。

示例：

#{
This is a block comment.
It can span multiple lines.
#}

set(SOME_VARIABLE "hello world")  # This is not a block comment

标题注释

CMake 中的标题注释以 "#" 开始，后跟一个或多个空格和文本，表示这是一个标题。

示例：

# Example CMake file

此外，也可以使用多个 '#' 来表示不同级别的标题。

## Section Heading
### Subsection Heading
#### Sub-subsection Heading

变量注释

在 CMake 文件中，我们可以定义各种变量。为了使代码更易于阅读和维护，我们可以添加注释来说明这些变量的用途。

示例：

# Define source files
set(SOURCE_FILES
    main.cpp  # The main entry point of the program
    foo.cpp   # Implementation of the foo function
    bar.cpp   # Implementation of the bar function
)

函数和命令注释

CMake 中有许多内置函数和命令，可以在 CMakeLists.txt 文件中使用。为了使代码更易于理解，我们还可以为这些函数和命令添加注释，以说明它们的作用。

示例：

# Add a library target
add_library(my_library SHARED ${SOURCE_FILES})

# Set the include directories
include_directories(${INC_DIR})

以上是 CMake 中注释的介绍。添加注释是良好的编程实践，可以使代码更明确易懂，并有助于提高代码的可维护性。