SublimeAStyleFormatter 使用教程
1、项目的目录结构及介绍
SublimeAStyleFormatter 是一个用于 Sublime Text 的代码格式化插件,支持 C/C++/C#/Java 文件的格式化。以下是项目的目录结构及其介绍:
SublimeAStyleFormatter/
├── AStyleFormatterLib/
├── messages/
├── pyastyle/
├── src/
├── tests/
├── .gitignore
├── .gitmodules
├── no-sublime-package
├── travis.yml
├── AStyleFormat.py
├── AStyleFormatter.sublime-commands
├── CHANGELOG.md
├── Context.sublime-menu
├── DONORS.md
├── Default (Linux).sublime-keymap
├── Default (OSX).sublime-keymap
├── Default (Windows).sublime-keymap
├── LICENSE
├── Main.sublime-menu
├── README.md
├── Side Bar.sublime-menu
├── SublimeAStyleFormatter.sublime-settings
├── appveyor.yml
├── dump_default_options
├── messages.json
├── options_default.json
├── package.json
├── unittesting.json
目录介绍
- AStyleFormatterLib/: 包含 AStyle 格式化库的相关文件。
- messages/: 包含插件的消息文件。
- pyastyle/: 包含与 AStyle 相关的 Python 文件。
- src/: 包含插件的源代码文件。
- tests/: 包含插件的测试文件。
- .gitignore: Git 忽略文件。
- .gitmodules: Git 子模块配置文件。
- no-sublime-package: 用于控制 Sublime Text 包的文件。
- travis.yml: Travis CI 配置文件。
- AStyleFormat.py: 主启动文件。
- AStyleFormatter.sublime-commands: 插件命令配置文件。
- CHANGELOG.md: 更新日志文件。
- Context.sublime-menu: 上下文菜单配置文件。
- DONORS.md: 捐赠者列表文件。
- Default (Linux).sublime-keymap: Linux 平台快捷键配置文件。
- Default (OSX).sublime-keymap: macOS 平台快捷键配置文件。
- Default (Windows).sublime-keymap: Windows 平台快捷键配置文件。
- LICENSE: 许可证文件。
- Main.sublime-menu: 主菜单配置文件。
- README.md: 项目说明文件。
- Side Bar.sublime-menu: 侧边栏菜单配置文件。
- SublimeAStyleFormatter.sublime-settings: 插件配置文件。
- appveyor.yml: AppVeyor CI 配置文件。
- dump_default_options: 默认选项导出工具。
- messages.json: 消息配置文件。
- options_default.json: 默认选项配置文件。
- package.json: 包信息文件。
- unittesting.json: 单元测试配置文件。
2、项目的启动文件介绍
项目的启动文件是 AStyleFormat.py
,它是插件的主入口文件,负责初始化和执行代码格式化的相关操作。
3、项目的配置文件介绍
项目的配置文件是 SublimeAStyleFormatter.sublime-settings
,它包含了插件的各种配置选项,如格式化规则、快捷键设置等。以下是配置文件的部分内容示例:
{
"default_executable_path": "astyle",
"executable_path": "",
"default_options": [
"--style=google",
"--indent=spaces=4",
"--align-pointer=name",
"--align-reference=name",
"--break-closing-brackets",
"--attach-namespaces",
"--max-code-length=120",
"--break-after-logical"
],
"options": [],
"format_on_save": false,
"format_on_save_extensions": {
"c": true,
"cc": true,
"cpp": true,
"cxx": true,
"h": true,
"hh": true,
"hpp": true,
"hxx":