CLion教程-代码格式化
CLion允许您根据您当前指定的代码风格方案来重新格式化您的代码。
您可以重新格式化代码片段、整个文件、一组文件、目录和模块。您还可以从重新格式化中排除部分代码或某些文件。
重新格式化代码片段
在编辑器中选择要重新格式化的代码片段。
- 在重新格式化之前,您可以查看应用于选定代码的代码样式设置:按下AltEnter并单击“Adjust code style settings”。
从主菜单中选择Code | Reformat Code,或按下CtrlAlt0L。
如果您没有选择代码片段,CLion将重新格式化整个文件。
重新格式化文件
要么在编辑器中打开您的文件并按下CtrlAltShift0L,要么在项目工具窗口中,右键单击文件,然后选择Reformat Code。
继续按住Shift并选择其他文件以进行批量重新格式化。
在打开的“Reformat File”对话框中,如果需要,选择以下重新格式化选项:
- 优化导入:如果要删除未使用的导入、添加缺失的导入或组织导入语句,请选择此选项。
- 代码清理:选择此选项以运行代码清理检查。
- 不保留换行符:根据代码样式设置重新格式化换行符。此选项会覆盖“Keep when reformatting | Line breaks”设置。
- 点击“Run”。
如果您想要查看重新格式化期间对代码所做的确切更改,请使用Local History功能。
重新格式化行缩进
您可以根据指定的设置重新格式化行缩进。
- 在编辑器中选择所需的代码片段,然后按下CtrlAlt0I。
- 如果您需要调整缩进设置,在设置对话框(CtrlAlt0S)中,转到Editor | Code Style。
- 在适当的语言页面上,转到Tabs and Indents选项卡,指定适当的缩进选项,然后单击“OK”。
在某些情况下,位于File | Settings | Editor | Code Style中的Indent Detection部分中的Detect and use existing file indents for editing选项可能会覆盖您的设置。在这种情况下,CLion将显示通知。
自动在保存时重新格式化代码
您可以在保存修改后的文件时,自动配置IDE以自动重新格式化代码。
- 按下CtrlAlt0S以打开IDE设置,然后选择Tools | Actions on Save。
- 启用Reformat code选项。
此外,您可以配置IDE重新格式化代码的方式:
- 单击Configure scope以指定要从重新格式化中排除的文件名和目录的模式。
- 从All file types列表中选择要在其中重新格式化代码的文件类型。
- 如果您的项目受版本控制,选择Whole file或Changed lines。
如果选择了Changed lines,重新格式化将仅适用于本地已更改但尚未检入到存储库的代码行。
从重新格式化中排除文件
您可以将一组文件和目录从重新格式化和导入优化中排除。
- 在设置对话框(CtrlAlt0S)中,转到Editor | Code Style。
- 切换到Formatter选项卡,在Do not format字段中,使用glob模式输入您要排除的文件和目录。
您可以使用分号;
分隔的多个glob模式。如果单击,该字段将展开,并且每个模式将显示在单独的行上。 - 应用更改并关闭对话框。
在编辑器中从重新格式化中排除代码片段
- 在设置对话框(CtrlAltS)中,转到Editor | Code Style。
- 切换到Formatter选项卡,并启用Turn formatter on/off with markers in code comments选项。
- 在编辑器中,在您想要排除的区域的开头,创建一行注释Ctrl+/,然后键入
@formatter:off
。在区域的末尾,创建另一行注释,并键入@formatter:on
。
标记之间的代码将不会被重新格式化。
保留现有格式
您可以选择要在重新格式化代码时忽略的格式规则。例如,您可以调整IDE以保留简单的方法和函数在一行中,而通常它们在代码重新格式化后会扩展为多行。
- 转到Settings | Editor | Code Style,选择您的编程语言,然后打开Wrapping and Braces选项卡。
- 在Keep when reformatting部分,选择要忽略的格式规则,取消选择要应用的规则。
- 重新格式化代码(CtrlAltL)。
CLion将根据当前的样式设置重新格式化您的代码,对于您选择的规则,将保留现有的格式。