如何让你的ObjC/Swift代码看起来更专业 - 强烈推荐Xcode格式化工具XCFormat

4,883 阅读4分钟

为什么要规范代码?

1、让你看起来更专业 (这点很重要)。

2、你的代码和业界规范保持一致,更容易被别人理解。

3、如果你是项目负责人,实施代码规范化,能让团队协作更高效。

换个角度,你阅读别人分享的代码时,发现带有强烈的个人特点,和业界公认的代码规范差别很大,你很大概率想要放弃,因为他已经给了你不专业的印象。

笔者的经验

iOS开发超过5年经验,经历过几个团队,也带过团队,有些感触:

1、重视代码规范的iOS开发者占比很小;

2、改变习惯很难:即使团队一再强调代码规范,不少人还是会忽略一些细节,继续以往的习惯;

3、团队负责人的代码规范意识决定了团队的代码输出质量。

相信不少人在工作中经常遇到别人“乱糟糟”的代码,倍感苦恼,强迫症患者会控制不住地想要“添加空格”,“增加换行”。对代码规范有严格要求的开发人员,也会面临经常调整代码格式的困扰,影响编码效率。

好消息是,我们可以借助一些工具来改善,确保代码符合规范的同时提高编码效率。

我在Xcode上使用格式化相关插件有几年的经验,从最初苹果对插件的不限制,到从xcode8开始对插件的完全屏蔽,一直没有放弃,因为使用一些插件能大大提高开发效率。

xcode8之后安装插件需要unsign xcode,但是只能用这个unsigned之后的xcode做开发工作,不能用于打包,因为不安全,苹果不会审核通过,打包时候需要切换回之前的xcode。 参考:iOS Xcode8 如何使用插件(Xcode_unsigned)

可选的插件很多,有些也被广泛使用,但是有个问题:每个插件只供特定uuid的Xcode使用,Xcode升级后uuid改变,导致插件失效,这时需要到插件安装目录,将所有插件引用的Xcode uuid值替换为Xcode升级后的uuid。 参考:解决Xcode装好了的插件不能使用

苹果虽禁用了插件,但也推出了扩展:"Xcode Source Editor Extension"。部分插件也支持扩展方式,使用扩展,不需要unsign xcode,也不用在升级了Xcode后登记新的uuid到插件安装目录下。

我们有不少方便高效的工具可以使用,但在多年的开发经验中,我也认识到:1、开发人员容易‘沉醉’于编码中,无暇其他;2、即使集成了高效开发的工具,也可能会因为Xcode升级导致插件失效而中断使用。

工欲善其事必先利其器。有时候是我们的‘懒得尝试’限制了视野,多走一小步,或许就会柳暗花明。

...

这里推荐的是在Xcode上使用的代码格式化工具 XCFormat。系个人备忘,也希望对你能有所帮助。Xcode版本:11.1。

1.安装XCFormat

打开Xcode,在菜单栏找到Xcode Extensions...

Xcode扩展入口

在打开的页面「使用Xcode扩展让编程更加快捷」中,找到XCFormat,点击安装。(XCFormat大概率在底部,上方的是收费扩展)。

Xcode-XCFormat扩展

2.在电脑的「系统设置->扩展」中开启XCFormat

系统设置-扩展中添加XCFormat

3.用XCFormat格式化代码

通过菜单「Xcode->Editor->XCFormat」格式化代码。

Xcode-XCFormat效果

4.为格式化菜单设置快捷键

为进一步提高效率,你也可以添加快捷键。 记住「Xcode->Editor->XCFormat」下的两个菜单名称,然后到电脑的「系统设置->键盘->快捷键->应用快捷键」下,输入菜单名称,添加快捷键。

为XCFormat设置快捷键

推荐阅读

 


很开心你读完此篇。 

我是夕月,程序媛一枚。 

30而立,2020年是摸索前行的一年,和星辰一起立下了发文分享的flag。 

如果你感兴趣,不妨常来看看,我们成长路上或许会有共鸣。

我们的博客站:xiyuechen.net   微信公众号「星辰和夕月」。

星辰和夕月