CLion教程-命名约定
设置 | 编辑器 | 代码风格 | C/C++,命名约定
作用域:IDE范围(默认)或项目范围
关联检查:不一致的命名
命名约定是一组旨在统一代码或项目中所有符号名称的规则。每个命名规则定义了特定类型标识符的后缀、前缀、大小写和复合词拼写方式。
请注意,您还可以从预定义的方案中选择命名约定(以及其他代码风格设置),例如Google或LLVM。
配置命名规则
- 打开"Settings | Editor | Code Style | C/C++"中的"Naming Convention"选项卡。
为代码中的实体指定命名设置:
- 您可以同时为多个实体应用一个规则。单击"Entity Kind"字段,然后选择多个选项:
如果清除所有复选框,规则将应用于所有实体种类。当在给定代码位置上有多个规则适用于实体时,CLion使用列表中的最后一个。
- 在"Naming Convention"字段中,选择拼写风格:"lowercase"、"camelCase"、"PascalCase"、"snake_case"、"Leading_upper_snake_case"、"Upper_Snake_Case"、"SCREAMING_SNAKE_CASE"或"UPPERCASE"。
- 您还可以为某些实体类型指定单独的规则(例如,当您对私有/公共类成员或静态/常量变量使用特定命名时)。为此,请在适用的地方设置"Visibility"和"Specifier"字段:
- 如有需要,请指定前缀和后缀(例如,为枚举设置前缀为"'e_'",为typedef设置后缀为"'t_'")。
- 您可以同时为多个实体应用一个规则。单击"Entity Kind"字段,然后选择多个选项:
- 要仅为当前项目保存配置的样式,请在方案切换器中选择"Project"。
CLion在执行以下操作时将考虑命名约定设置:
- 代码完成,
- 代码生成,包括Live Templates,
- 包括代码生成的快速修复(如add parameter to constructor、change function signature according to call等),
- 提取/内联重构。
检查代码是否违反命名规则
您可以使用"Inconsistent Naming"检查功能检查代码是否与配置的命名约定一致。默认情况下,此检查功能已禁用。要启用它,请转到"Settings | Editor | Inspections | C/C++ | General"。
- 启用后,此检查功能会突出显示违反命名规则的符号,并建议快速修复来立即更改它们:
- 此外,您还可以单独运行此检查功能,以检查整个代码库或文件子集。为此,请运行"Code | Inspect Code",或调用Run Inspection by Name对话框CtrlAltShift0I,并搜索"Inconsistent Naming"。结果将在检查结果工具窗口中列出: