CNCC 项目常见问题解决方案

CNCC 项目常见问题解决方案

1. 项目基础介绍和主要编程语言

项目介绍：
CNCC（Customizable Naming Convention Checker）是一个用于检查C++代码命名规范的工具。它使用Clang前端，直接在语言的抽象语法树（AST）上进行工作。与clang-format类似，但CNCC专注于命名规范的检查。用户可以定义正则表达式来验证AST节点，如类名、变量名、命名空间名等，以符合特定的命名约定。

主要编程语言：
C++（Clang），Python（用于脚本和集成）

2. 新手常见问题及解决步骤

问题一：如何安装和配置CNCC

问题描述：
新手用户在开始使用CNCC时，可能不清楚如何安装和配置这个工具。

解决步骤：

1. 安装依赖：
   CNCC需要安装Python 2、python-clang和python-yaml。可以使用pip进行安装：

   pip install python-clang python-yaml
   

2. 获取源代码：
   克隆GitHub仓库到本地：

   git clone https://github.com/mapbox/cncc.git
   

3. 配置风格文件：
   创建一个风格文件（例如my_style.cncc），定义命名规范的正则表达式。例如：

   class_decl: '^([A-Z][a-z]+)+$'
   field_decl: '^[a-z]+_$'
   var_decl: '^[a-z][a-z0-9]*$'
   namespace: '^[a-z]+$'
   

4. 运行CNCC：
   使用CNCC命令检查C++文件，指定风格文件：

   cncc --style=my_style.cncc examples/test.cc
   

问题二：如何使用CNCC检查项目中的命名规范

问题描述：
用户可能不清楚如何使用CNCC来检查整个项目中的命名规范。

解决步骤：

1. 创建编译数据库：
   使用CMake或Bear生成编译命令数据库（compile_commands.json），以便CNCC可以知道如何编译项目中的每个文件。

2. 运行CNCC：
   指定编译数据库目录和风格文件运行CNCC：

   cncc --style=~/my_style.cncc --dbdir=/path/to/compile_commands.json
   

问题三：如何处理CNCC发现的命名规范问题

问题描述：
用户在使用CNCC后，可能会发现一些命名规范问题，但不清楚如何修复这些问题。

解决步骤：

1. 阅读错误报告：
   CNCC会在标准错误输出中报告不符合命名规范的问题，包括文件名、行号和错误描述。

2. 修改代码：
   根据错误报告，手动修改代码中的变量、类、命名空间等，使其符合定义的命名规范。

3. 重新运行CNCC：
   修改代码后，重新运行CNCC以验证命名规范问题是否已解决：

   cncc --style=my_style.cncc examples/test.cc
   

确保所有问题都被修复后，您的代码应该符合定义的命名规范。