Ubuntu下C++如何进行代码审查

Ubuntu下C++代码审查实操指南

一流程与角色

明确目标：优先发现缺陷与安全风险、保证可读性与可维护性，而非形式化挑错。
分支策略：采用Git 分支 + Pull/Merge Request 工作流，提交前本地自检，提交后由至少1人进行同行评审，通过后再合入主干。
审查清单：接口与ABI变更、资源管理（RAII、智能指针）、并发与线程安全、错误处理、可测试性、依赖与编译影响、日志与性能回归、注释与文档一致性。

二本地静态检查与格式化

编译器与警告
- 使用GCC/Clang高警告等级并视为错误：例如 g++ -Wall -Wextra -Werror -pedantic -std=c++17 ...；Clang 可用 -Weverything（按需精简）。
Clang-Tidy（缺陷检测 + 现代化建议）
- 安装：sudo apt-get install clang-tidy
- 生成编译数据库（CMake）：cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
- 基本用法：clang-tidy src/main.cpp -checks='readability-*,cppcoreguidelines-*'
- 自动修复：clang-tidy src/main.cpp -fix（建议提交前在版本控制下操作）
- 项目级配置：根目录 .clang-tidy
```
---
Checks: 'modernize-*, readability-*, cppcoreguidelines-*, bugprone-*, performance-*'
WarningsAsErrors: ''
HeaderFilter: '.*'
FormatStyle: file
```
- 提示：配合 -fix 与 .clang-format 可统一格式与部分修复。
Cppcheck（静态分析，捕捉编译器不易发现的问题）
- 安装：sudo apt-get install cppcheck
- 常用命令：
  - 目录递归：cppcheck --enable=all --std=c++17 src/
  - 并行与输出：cppcheck --jobs=4 --xml --xml-version=2 src/ 2> report.xml
  - 使用编译数据库：cppcheck --project=compile_commands.json
  - 忽略特定告警：cppcheck --suppress=unusedFunction ...
- 建议与 CI 集成，生成XML/HTML报告便于归档与追踪。
Clang-Format（统一格式，减少“格式之争”）
- 安装：sudo apt-get install clang-format
- 使用：clang-format -style=file -i src/**/*.cpp src/**/*.hpp
- 建议将 .clang-format 纳入版本控制，统一团队风格。
动态检查（运行时缺陷）
- Valgrind（内存与调用问题）：valgrind --tool=memcheck --leak-check=full --show-reachable=yes ./your_app
- 关注输出中的 definitely lost / indirectly lost 等指标，合入前要求清零或给出合理说明。

三编辑器与 IDE 集成

VS Code
- 安装 C/C++ 扩展；在设置或 settings.json 中启用/配置 Clang-Tidy 与 Cppcheck 的 lint 能力；保存即检、问题面板集中展示，便于逐条修复与回复评审意见。
Vim/Neovim
- 使用 ALE 或 Coc.nvim 插件，配置 clang-tidy/cppcheck 为异步 linter，边写边提示，减少提交前返工。
CLion
- 内置 Clang-Tidy 支持，可在设置中启用检查项、配置 compile_commands.json，并与 Clang-Format 联动，提交前一键检查与格式化。

四代码审查清单与提交前自检脚本

清单要点
- 正确性：边界条件、未定义行为、异常安全、数值溢出与类型窄化。
- 资源管理：RAII、智能指针、锁的配对、文件/句柄关闭。
- 并发：数据竞争、死锁、可见性与内存序（必要时用 std::atomic/memory_order）。
- 接口与兼容性：API 变更、ABI 影响、向后兼容策略。
- 可测试性：单测覆盖、依赖注入、可观测性（日志/打点）。
- 性能与复杂度：热点路径、算法复杂度、不必要的拷贝/分配。
- 风格与可读性：命名、注释、格式一致性、头文件组织（前置声明、include 顺序）。
- 安全：输入校验、格式化字符串、整数溢出、容器越界。

提交前自检脚本示例（可放入 scripts/pre-commit 并 chmod +x）

#!/usr/bin/env bash
set -euo pipefail

echo "=== [pre-commit] 格式化检查 ==="
if ! git diff --quiet --cached -- '*.cpp' '*.hpp' '*.cc' '*.hh'; then
  clang-format -style=file -i $(git diff --cached --name-only -- '*.cpp' '*.hpp' '*.cc' '*.hh')
  git add $(git diff --name-only -- '*.cpp' '*.hpp' '*.cc' '*.hh')
fi

echo "=== [pre-commit] Clang-Tidy 检查 ==="
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -B build -S . >/dev/null
find src -name '*.cpp' | xargs clang-tidy -p build -warnings-as-errors='*'

echo "=== [pre-commit] Cppcheck 检查 ==="
cppcheck --enable=warning,performance,portability,unusedFunction \
         --std=c++17 --project=build/compile_commands.json \
         --xml --xml-version=2 src/ 2> cppcheck-report.xml || true
if grep -q "<error " cppcheck-report.xml; then
  echo "Cppcheck 发现问题，请修复后再提交："
  grep -o 'message="[^"]*"' cppcheck-report.xml | sort -u
  exit 1
fi

echo "=== [pre-commit] 单元测试 ==="
cmake --build build --target test || { echo "单元测试失败"; exit 1; }

echo "=== [pre-commit] 通过 ==="

说明：该脚本在提交前自动格式化、运行 Clang-Tidy 与 Cppcheck，并阻止未通过检查的提交；WarningsAsErrors 可在本地宽松、在 CI 严格。

五团队协作与 CI

代码托管与评审
- 使用 Gerrit 或 Phabricator 进行基于 Git 的代码评审、评论与打分，结合门禁策略保证合入质量。
持续集成
- 使用 Jenkins 或 GitHub Actions 在每次提交/PR 时自动运行：构建、单元测试、静态检查、覆盖率与报告归档；必要时将 Clang-Tidy/Cppcheck 结果设为门禁条件，未通过则阻断合入。
覆盖率与质量看板
- 使用 gcov + LCOV 生成覆盖率报告，与 Jenkins/GitHub Pages 集成，直观查看新增代码的测试覆盖情况。

最新问答

相关标签