前言

代码风格不仅仅关乎美观,更是代码质量的重要组成部分。良好的代码风格能够提高代码的可读性,减少错误的发生概率,进而提升软件的整体质量。具体来说,统一的代码风格有助于:

  • 提高可读性:一致的格式化规则使得代码更容易被其他开发者理解,尤其是在多人协作的项目中,这一点尤为重要。
  • 减少错误:规范化的代码风格可以避免一些常见的编程错误,如括号配对错误等,从而提高代码的稳定性。
  • 促进团队协作:当团队成员遵循相同的代码风格时,代码审查过程变得更加高效,减少了因风格差异导致的沟通障碍,使得团队合作更加和谐。

综上所述,通过第三方插件工具来统一代码风格,不仅能提升代码的质量,还能增强团队的凝聚力,推动项目的顺利进行。

准备插件

去官网(https://astyle.sourceforge.net/)下载astyle-3.4.11-x64.zip

下载好以后,解压到任意盘中,此处我选择把它和Qt的安装根目录下,如下图所示

image-20250212133426095

安装配置

打开Qt Creator软件,进入到主界面,点击菜单中的“帮助“,下拉菜单选择”关于插件",打开插件管理界面

image-20250212133709032

勾选Beautifier项,然后重启软件,即可

重启软件以后,依次点击“工具”->"选项",打开软件配置管理界面,找到刚刚安装的Beautifier

image-20250212134027117

这里会发现,美化器(Beautifier)支持三种格式样本 Artistic Style、ClangFormat、Uncrustify,本文只介绍第一种

点击“Artistic Style”标签,选择刚刚解压的astyle-3.4.11-x64路径,勾选自定义样式,

image-20250212150937116

点击“Add”按钮,打开配置界面

image-20250212151224140

名字随便写一个,Value的值复制下方的参数,

提示:仅供参考,要改的话,自行百度Artistic
--recursive
--style=allman
--convert-tabs
--indent=spaces=4
--attach-closing-while
--indent-switches
--indent-namespaces
--indent-continuation=4
--indent-preproc-block
--indent-preproc-define
--indent-preproc-cond
--indent-col1-comments
--pad-oper  
--pad-header
--unpad-paren
--delete-empty-lines
--align-pointer=name
--align-reference=name
--add-braces
--pad-comma
--unpad-paren
--add-one-line-braces
--attach-return-type-decl
--attach-extern-c
--min-conditional-indent=2
--max-continuation-indent=40
--max-code-length=100
--break-after-logical

点击“Ok”,完成自定义样式添加,点击“Apply”保存设置,关闭界面即可

image-20250212151502696

结束语

至此,代码格式化插件配置结束,其他插件的配置或使用,可参考博客Qt Beautifier 整理你的代码

使用过程中,保存会自动调整代码格式。