VSCode的Objective-C代码为什么格式化不生效？教你设置uncrustify的方法

安装并配置Uncrustify工具，通过设置vscode的C/C++扩展使用Uncrustify可执行文件及正确路径的.uncrustify.cfg配置文件，实现Objective-C代码格式化。

VSCode的Objective-C代码格式化不生效，通常是因为没有正确配置合适的格式化工具。Uncrustify是一个强大的代码格式化工具，通过正确配置，可以解决这个问题。

安装并配置Uncrustify，让VSCode识别并使用它来格式化Objective-C代码。

安装Uncrustify

首先，你需要安装Uncrustify。根据你的操作系统，安装方式会有所不同。

• macos: 可以使用Homebrew：

  brew install uncrustify
• linux (debian/ubuntu): 可以使用apt：

  sudo apt-get install uncrustify
• windows: 可以从Uncrustify的官方网站下载预编译的二进制文件：https://www.php.cn/link/b36a8b7fdf47ca209ce8a08ecd8b2ff0

安装完成后，确保Uncrustify的可执行文件在你的系统PATH环境变量中。你可以在终端中运行

uncrustify --version

来验证安装是否成功。如果成功，会显示Uncrustify的版本信息。

配置VSCode

安装好Uncrustify后，需要在VSCode中进行配置，告诉VSCode使用Uncrustify来格式化Objective-C代码。

1. 安装C/C++扩展: 在VSCode中搜索并安装microsoft提供的C/C++扩展。这个扩展提供了代码格式化功能，并且可以配置使用外部格式化工具。

2. 配置settings.json: 打开VSCode的设置（File -> Preferences -> Settings，或者使用快捷键

   Ctrl+,

   ），搜索

   C_Cpp.formatting

   。

3. 设置

   C_Cpp.formatting.provider

   : 将

   C_Cpp.formatting.provider

   设置为

   uncrustify

   。

4. 设置

   C_Cpp.formatting.uncrustify.executable

   : 设置

   C_Cpp.formatting.uncrustify.executable

   为Uncrustify可执行文件的路径。例如，在macOS上，可能是

   /usr/local/bin/uncrustify

   。在Windows上，可能是

   C:Program FilesUncrustifyuncrustify.exe

   。你需要根据你的实际安装路径进行调整。

5. 创建Uncrustify配置文件: Uncrustify使用一个配置文件来定义代码格式化的规则。创建一个名为

   .uncrustify.cfg

   的文件，放在你的项目根目录下，或者放在你的用户目录下（这样可以作为全局配置）。

6. 配置

   .uncrustify.cfg

   : 在

   .uncrustify.cfg

   文件中，添加你想要的Objective-C代码格式化规则。Uncrustify的配置文件非常灵活，可以自定义各种格式化选项。例如，你可以设置缩进、空格、换行等规则。一个简单的

   .uncrustify.cfg

   文件可能如下所示：

   # Objective-C mod_indent_oc_block = true mod_indent_oc_brace = true indent_columns = 4 indent_with_tabs = 0

   这个配置表示使用4个空格进行缩进，并且对Objective-C的代码块和花括号进行缩进。

7. 配置

   C_Cpp.formatting.uncrustify.configFile

   : 在VSCode的

   settings.JSon

   中，设置

   C_Cpp.formatting.uncrustify.configFile

   为

   .uncrustify.cfg

   文件的路径。例如，如果

   .uncrustify.cfg

   文件在你的项目根目录下，你可以设置为

   ${workspaceFolder}/.uncrustify.cfg

   。如果

   .uncrustify.cfg

   文件在你的用户目录下，你可以设置为

   ${env:HOME}/.uncrustify.cfg

   。

8. 格式化代码: 配置完成后，你可以尝试格式化你的Objective-C代码。在VSCode中打开一个Objective-C文件，然后使用快捷键

   Shift+Alt+F

   （或者右键点击，选择”Format Document”）来格式化代码。如果一切配置正确，Uncrustify会根据你的

   .uncrustify.cfg

   文件中的规则来格式化代码。

Uncrustify配置不生效的常见原因

即使按照上述步骤配置了Uncrustify，有时仍然可能遇到格式化不生效的问题。以下是一些常见的原因和解决方法：

• Uncrustify可执行文件路径错误: 确保

  C_Cpp.formatting.uncrustify.executable

  设置的路径是正确的。如果路径错误，VSCode无法找到Uncrustify的可执行文件，导致格式化失败。

• .uncrustify.cfg

  文件路径错误: 确保

  C_Cpp.formatting.uncrustify.configFile

  设置的路径是正确的。如果路径错误，Uncrustify无法找到配置文件，导致使用默认的格式化规则，或者格式化失败。

• .uncrustify.cfg

  文件语法错误: 如果

  .uncrustify.cfg

  文件中存在语法错误，Uncrustify可能无法正确解析配置文件，导致格式化失败。可以使用Uncrustify的命令行工具来验证配置文件的语法是否正确：

  uncrustify -c .uncrustify.cfg --check

  。

• VSCode C/C++扩展冲突: 有时，VSCode的C/C++扩展可能与其他扩展冲突，导致格式化功能异常。可以尝试禁用其他扩展，然后重新启动VSCode，看看是否解决了问题。

• 文件类型关联问题: 确保VSCode正确识别Objective-C文件。检查文件关联设置，确保

  .m

  文件关联到C++语言。

如何调试Uncrustify配置

调试Uncrustify配置可能需要一些耐心，以下是一些调试技巧：

• 查看VSCode的输出: 在VSCode的输出面板中，选择”C/C++”通道，可以查看C/C++扩展的输出信息。如果Uncrustify配置有问题，可能会在这里看到相关的错误信息。

• 使用Uncrustify的命令行工具: 可以使用Uncrustify的命令行工具来测试格式化效果。例如，可以使用以下命令来格式化一个Objective-C文件：

  uncrustify -c .uncrustify.cfg -f your_file.m

  。

• 逐步调整

  .uncrustify.cfg

  文件: 可以逐步调整

  .uncrustify.cfg

  文件中的配置选项，每次修改后都尝试格式化代码，看看是否达到了预期的效果。

• 参考Uncrustify的文档: Uncrustify的官方文档包含了大量的配置选项和示例，可以参考文档来配置

  .uncrustify.cfg

  文件。

Uncrustify配置文件

.uncrustify.cfg

的常用配置选项

Uncrustify的配置文件非常灵活，可以自定义各种格式化选项。以下是一些常用的配置选项：

• indent_columns

  : 缩进的空格数。例如，

  indent_columns = 4

  表示使用4个空格进行缩进。

• indent_with_tabs

  : 是否使用制表符进行缩进。

  indent_with_tabs = 0

  表示使用空格进行缩进，

  indent_with_tabs = 1

  表示使用制表符进行缩进。

• mod_indent_oc_block

  : 是否对Objective-C的代码块进行缩进。

  mod_indent_oc_block = true

  表示对Objective-C的代码块进行缩进。

• mod_indent_oc_brace

  : 是否对Objective-C的花括号进行缩进。

  mod_indent_oc_brace = true

  表示对Objective-C的花括号进行缩进。

• sp_before_oc_block_open

  : 在Objective-C的代码块的左花括号之前是否添加空格。

  sp_before_oc_block_open = add

  表示添加空格。

• sp_after_oc_block_close

  : 在Objective-C的代码块的右花括号之后是否添加空格。

  sp_after_oc_block_close = add

  表示添加空格。

• nl_before_oc_protocol

  : 在Objective-C的协议声明之前是否添加换行。

  nl_before_oc_protocol = add

  表示添加换行。

• nl_before_oc_category

  : 在Objective-C的分类声明之前是否添加换行。

  nl_before_oc_category = add

  表示添加换行。

• nl_before_oc_interface

  : 在Objective-C的接口声明之前是否添加换行。

  nl_before_oc_interface = add

  表示添加换行。

• nl_before_oc_implementation

  : 在Objective-C的实现声明之前是否添加换行。

  nl_before_oc_implementation = add

  表示添加换行。

• nl_before_oc_end

  : 在Objective-C的

  @end

  指令之前是否添加换行。

  nl_before_oc_end = add

  表示添加换行。

其他代码格式化工具的选择

除了Uncrustify，还有其他的代码格式化工具可以用于Objective-C代码的格式化，例如：

• ClangFormat: ClangFormat是Clang编译器的代码格式化工具，可以用于格式化C、C++、Objective-C等代码。ClangFormat的配置方式与Uncrustify类似，也需要创建一个配置文件，并在VSCode中进行配置。

• OCLint: OCLint是一个静态代码分析工具，可以用于检查Objective-C代码中的潜在问题。OCLint也可以用于代码格式化，但是OCLint的代码格式化功能相对简单，不如Uncrustify和ClangFormat灵活。

选择哪个代码格式化工具取决于你的个人偏好和项目需求。Uncrustify是一个功能强大、配置灵活的代码格式化工具，适合对代码格式化有较高要求的项目。ClangFormat是一个流行的代码格式化工具，与Clang编译器集成，适合使用Clang编译器的项目。OCLint是一个静态代码分析工具，可以用于检查代码质量和格式，适合对代码质量有较高要求的项目。

总结

配置Uncrustify来格式化VSCode中的Objective-C代码，需要安装Uncrustify，配置VSCode的C/C++扩展，创建

.uncrustify.cfg

文件，并设置正确的路径。如果遇到问题，可以检查Uncrustify的可执行文件路径、

.uncrustify.cfg

文件路径、

.uncrustify.cfg

文件语法，以及VSCode的扩展冲突。通过逐步调试和参考Uncrustify的文档，可以解决大多数配置问题，让VSCode能够正确格式化Objective-C代码。