SublimeClangFormat 项目启动与配置教程

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

SublimeClangFormat 项目的主要目录结构如下：

SublimeClangFormat/
├── .gitignore           # Git 忽略文件列表
├── README.md            # 项目说明文件
├── sublime-clang-format.py # Sublime Text 插件主文件
├── .clang-format         # ClangFormat 配置文件
└── test/                # 测试代码目录

• .gitignore：此文件列出了一些在执行 Git 操作时应该被忽略的文件和目录，以避免将不必要的文件提交到版本控制中。
• README.md：项目的说明文件，包含了项目的介绍、安装、配置和使用说明。
• sublime-clang-format.py：Sublime Text 插件的主文件，实现了 ClangFormat 功能的集成。
• .clang-format：ClangFormat 的配置文件，定义了代码格式化的规则。
• test/：包含了用于测试插件功能的测试代码。

2. 项目的启动文件介绍

sublime-clang-format.py 是项目的启动文件，也是 Sublime Text 插件的核心。这个文件中定义了插件的主要功能，包括：

• 监听 Sublime Text 中的事件，如保存文件时自动触发格式化。
• 调用 ClangFormat 命令来格式化 C/C++ 代码。
• 用户界面交互，如设置配置选项。

当 Sublime Text 启动并加载插件时，该文件会被执行，并且插件的各项功能会被集成到编辑器中。

3. 项目的配置文件介绍

.clang-format 文件是 ClangFormat 的配置文件，它用于定义代码格式化的规则。这个文件通常包含以下内容：

BasedOnStyle: Google
ColumnLimit: 80
Language: Cpp

• BasedOnStyle：指定基础样式为 Google，这意味着格式化规则将遵循 Google 的代码风格指南。
• ColumnLimit：指定每行代码的最大列数限制，这里是 80 列。
• Language：指定语言为 C++，这告诉 ClangFormat 如何处理 C++ 代码的格式化。

用户可以根据自己的喜好和项目要求修改这个配置文件，以实现不同的代码风格和格式化选项。在修改配置后，插件将使用新的规则来格式化代码。