# Cpp Code Standard

> 按统一规范编写、修改和审查自写 C/C++ 代码，检查命名、排版、注释、类型及现代 C++ 用法。用于用户明确要求采用本规范，或仓库已声明采用本规范的工程。

- Skill: `miaoge-ge/cpp-code-standard` (Agent Skill, multi-file: 7 files)
- Install (CLI): `npx get-skill add miaoge-ge/cpp-code-standard`
- Raw SKILL.md: https://api.skillmd.com/api/skills/miaoge-ge/cpp-code-standard/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: Miaoge-Ge (https://skillmd.com/u/miaoge-ge)
- Updated: 2026-11-12
- Page: https://skillmd.com/skills/miaoge-ge/cpp-code-standard

---


# C/C++ 代码规范

## 执行流程

1. 读取适用的仓库指令、构建与格式配置，确认修改范围、语言版本、模块命名风格和外部接口约束。
2. 编写或修改代码前读取涉及的规则；完整审查时读取并检查全部四类规则。
   - [命名](references/naming.md)：文件、变量、类型、函数、命名空间、宏和枚举值。
   - [排版](references/formatting.md)：大括号、空格、空行、对齐、编码和换行。
   - [注释](references/comments.md)：文件头、函数说明、函数体及成员说明。
   - [类型](references/types.md)：基本类型、整数宽度、类型别名和接口签名。
   - [现代 C++](references/modern-cpp.md)：内存安全、RAII、异常安全、移动语义与编译安全。
3. 按规则处理指定范围内的自写代码，保留外部接口、协议字段、序列化键和 ABI 兼容性。仅审查时不修改文件。
4. 检查最终差异；涉及行为变化时运行相关构建或已有验证，报告结果及未验证范围。

## 实现要求

- 优先使用 SDK 已有接口，核对签名、重载、返回值和默认值，避免重复封装已有的读取、解析或转换能力。
- 简单流程直接使用函数和清晰的资源清理路径；仅在需要维护状态、表达对象关系或多态接口时引入类。
- 公共函数不包含具体任务的业务数据；共享流程按实际复用需求提取，已有明确实现要求时按要求执行。
- 不修改第三方或生成代码，不扩大为无关重命名、批量转码或整体重排。格式化前确认配置符合规则，格式化后检查差异。

## 自动检查

`scripts/check_headers.py` 检查 C/C++ 文件头的 Doxygen `@file`/`@brief`、头文件包含保护，以及头文件中的 `using namespace`：

```bash
python scripts/check_headers.py path/to/include
```

加 `--strict` 时会额外检查头文件是否包含 `@brief`；脚本只做快速自查，不替代编译器、clang-tidy 或项目检查。

## 审查输出

逐项给出文件与行号、不符合的规则、影响及最小修复建议，区分风格问题和行为问题。未发现问题时说明检查范围及验证结果。

