IOS代码规范格式化-CLangFormat

对于每一个开发团队，都有自己自由的一套IOS开发规范。但是，如果在初建设的时候没有注意到这个问题，后面修改上来就有很大的问题。所以，为了弥补找个问题，在这里为大家推荐一款，自定义插件：** CLangFormat**

安装流程

1.先安装Package Manager（也可以跳过，看第2步）

package manager除了有这个以外，还有特别多的其他工具可以供xcode使用。

• 官网地址：https://github.com/supermarin/Alcatraz
• 安装方法：在终端输入：curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh

安装成功后，可以使用

图1

2. 安装CLangFormat

• 打开package manager
• 搜索框输入clang，找到ClangFormat，然后点击INSTALL
  图2
• 安装成功后，重启Xcode

3.可以使用内置规范，也可以自定义规范

• 直接使用体验

• 全选需要格式化的所在页面代码，然后【图3】的第一项，马上就有效果。路径:xcode->菜单edit->最下方->使用第一个就有效果

  
  图3

• 自定义使用方法

  • 1.在工程目录或者workspace目录下创建一个".clang-format"文件，添加类似于以下内容的参数：

//基础样式  
BasedOnStyle: LLVM  
//缩进宽度  
IndentWidth: 4  
//圆括号的换行方式  
BreakBeforeBraces: Attach  
//支持一行的if  
AllowShortIfStatementsOnASingleLine: true  
// switch的case缩进  
IndentCaseLabels: true  
// 针对OC的block的缩进宽度  
ObjCBlockIndentWidth: 4  
//针对OC，属性名后加空格  
ObjCSpaceAfterProperty: true  
//每行字符的长度  
ColumnLimit: 0  
//注释对齐  
AlignTrailingComments: true  
//括号后加空格  
SpaceAfterCStyleCast: true  

• 2.然后在Xcode的“Edit”->“CLang Format”中选中“File”，并让倒数第二行显示“Disable Format On Save”。

  
  使用自定义格式化

• 3.可以在官网上看到对应的文字格式化 点我查看官网

4.加入快捷键，使得更好的利用格式化

• 1.打开系统的 Preferences(偏好设置) > Keyboard（键盘） > Shortcuts（快捷键） > App Shortcuts（应用快捷键）【图4】 > Click +（点击添加）
  

  图4，应用快捷键

• 2.点击+，应用程序选Xcode，菜单填写对应的栏目【图5】，

  
  图5

• 3.打开xcode对应的位置，可以发现已经可以使用快捷键【图6】

图6，已经可以使用快捷键

5.测试：代码不多于80个字符，背后默默使用快捷键实现。

效果如下

代码不多于80个字符

注意：代码格式化工具虽然好用，但是，工具毕竟是工具，还是不够人性化。最重要是个人对格式化的自觉认知。书写的时候注意，减少工具的使用，才是王道!!

IOS 开发规范文档

*Reference

[1]iOS 代码格式化管理
[2]Clang-Format Style Options
[3]Xcode实用快捷键及插件整理