Qt Creator Cppcheck 集成插件使用教程

1. 项目的目录结构及介绍

目录结构

qtc-cppcheck/
├── src/
│   ├── translation/
│   ├── util/
│   ├── appveyor.yml
│   ├── .gitattributes
│   ├── .gitignore
│   ├── .travis.yml
│   ├── LICENSE.md
│   ├── QtcCppcheck.json.in
│   ├── README.md
│   ├── paths.pri
│   ├── qtc-cppcheck.pro
│   └── uncrustify.cfg
└── README.md

目录介绍

• src/: 包含插件的主要源代码。
  • translation/: 包含插件的翻译文件。
  • util/: 包含插件的实用工具代码。
  • appveyor.yml: AppVeyor 持续集成配置文件。
  • .gitattributes: Git 属性配置文件。
  • .gitignore: Git 忽略配置文件。
  • .travis.yml: Travis CI 持续集成配置文件。
  • LICENSE.md: 插件的许可证文件。
  • QtcCppcheck.json.in: 插件配置文件模板。
  • README.md: 项目主 README 文件。
  • paths.pri: Qt 项目路径配置文件。
  • qtc-cppcheck.pro: Qt 项目主配置文件。
  • uncrustify.cfg: 代码格式化配置文件。

2. 项目的启动文件介绍

启动文件

• qtc-cppcheck.pro: 这是项目的启动文件，它包含了项目的所有配置信息，包括源代码路径、依赖项、编译选项等。通过运行这个文件，可以编译和安装插件。

启动文件内容示例

TEMPLATE = lib
TARGET = qtc-cppcheck
DEPENDPATH += .
INCLUDEPATH += .

# 添加源文件
SOURCES += src/main.cpp \
           src/cppcheckplugin.cpp

# 添加头文件
HEADERS += src/cppcheckplugin.h

# 其他配置
...

3. 项目的配置文件介绍

配置文件

• QtcCppcheck.json.in: 这是插件的配置文件模板，用于配置 Cppcheck 的各种参数，如检查级别、忽略的警告等。

配置文件内容示例

{
  "cppcheck": {
    "binary": "/path/to/cppcheck",
    "arguments": "--enable=all",
    "projectPath": "%[CurrentProject:Path]"
  }
}

配置文件说明

• binary: Cppcheck 的可执行文件路径。
• arguments: 传递给 Cppcheck 的参数，如 --enable=all 表示启用所有检查。
• projectPath: 当前项目的路径，用于指定检查的代码范围。

通过以上配置，可以灵活地调整 Cppcheck 的检查行为，以适应不同的开发需求。