IOS代码规范格式化-CLangFormat

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

安装流程

1.先安装Package Manager(也可以跳过,看第2步)

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

安装成功后,可以使用


图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实用快捷键及插件整理

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,922评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,591评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,546评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,467评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,553评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,580评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,588评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,334评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,780评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,092评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,270评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,925评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,573评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,194评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,437评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,154评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,127评论 2 352

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 基于多目标规划的资本结构优化模型理论研究 杨琴(安徽商贸职业技术学院 会计系,安徽 芜湖 241002) **摘要...
    zhaohaoying阅读 399评论 0 0
  • 谁言书生无用?笔下方显英雄!
    凌尊阅读 116评论 0 3