在iOS开发过程中,写注释是一项必不可少的工作。这不仅有助于自己对代码整理回顾,而且提高了代码的可读性,让代码维护变得容易。但是,写注释又是一项枯燥的工作。我们浪费了大量的时间在输入/*
,*
,*/
这样的字符中。并且,这些字符输入非常麻烦。VVDocumenter-Xcode
,把我们从枯燥的字符输入中解放出来。
什么是VVDocumenter-Xcode
VVDocumenter是一个能够帮助我们快速生成注释模板的插件。我们只要在需要注释的方法前输入///
,注释就会自动生成,并提取出各个参数和返回值。我们只需要填写占位符的内容即可完成注释的编写。给出一张效果图,感受一下。
顺便说一下,VVDocumenter同样支持Swift。上周,中国第一届Swift大会成功举办。我相信,国内会掀起一场Swift学习的热潮。
安装和使用VVDocumenter-Xcode
最好的安装方法就是通过Alcatraz
。从Github上下载Alcatraz的Repo,使用Xcode编译就完成了安装。之后,重启Xcode并按下⇧⌘9
,打开Alcatraz
,搜索VVDocumenter
,点击左上角的INSTALL
,就会自动安装了。
如果不想通过Alcatraz
来安装,我们同样可以下载VVDocumenter的Repo,在Xcode中进行编译来安装。重启Xcode之后,就可以使用///
来自动生成注释了。
如果你不喜欢使用///
,可以在Xcode的Window菜单中,找到VVDocument,打开设置面板,修改Trigger Input
项。在设置选项中,还可以修改tab的空格数以及生成的注释的样式。
Xcode的版本
从Xcode 5.0开始,苹果给所有的插件都增加了UUID验证,以保证Xcode在更新之后的稳定性。插件的plist文件中的DVTPlugInCompatibilityUUIDs
值,包含了当前Xcode版本的UUID,否则插件不起作用。
从Xcode 6.3开始,如果我们使用插件,会被提示Load third party bundle
。我们应该选择Load bundles
,以保证插件可用。如果我们不小心选择了skip bundle
,可以使用下面的命令行,重置这条提示。
defaults delete com.apple.dt.Xcode DVTPlugInManagerNonApplePlugIns-Xcode-{your_xcode_version}
当Xcode更新后,所有插件都会无效。因为插件的plist中的DVTPlugInCompatibilityUUIDs
值没有包含最新的版本Xcode的UUID。这时,我们应该试着删除插件目录(默认是~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
)下的VVDocument,然后从master分支clone、编译最新版本。也可以尝试使用Alcatraz
重新安装。
更多的插件
在Xcode中使用插件会让我们的开发更加快捷。唐巧在《iOS开发进阶》一书中,为我们推荐了许多好用的插件。大家也可以在Alcatraz
中去寻找适合自己的插件。
下面,附上《iOS开发进阶》一书中提到的常用插件。
KSImageNamed是一个能帮助你输入
[UIImage imageNamed:]
中的资源名的插件。当你输入[UIImage imageNamed:]
时,会自动弹出上下文菜单,供你选择你需要输入的图片资源名字,另外在选择图片资源时,还可以在左侧预览该资源。XVim是一个Xcode的vim插件,可以在Xcode的编辑窗口中开启vim模式。vim模式最大的好处是可以全键盘操作,可以方便地移动光标,以及复制、粘贴代码。XVim对于Xcode的分栏模式也有很好的支持,与vim自带的分栏模式一样,可以用快捷键Ctrl + W来切换当前编辑的分栏。
FuzzyAutocompletePlugin允许使用模糊的方式来进行代码自动补全。举个栗子,如果我们要重载ViewDidAppear:方法,那么我们必须依次键入view、did、appear才能得到相应的补全信息,使用FuzzyAutocompletePlugin之后,我们可以键入vda(view、did、appear三个单词的首字母),或任意符合viewDidAppear整个单词出现顺序的子串(例如vdapp,idear等),即可匹配到该方法。
XToDo是一个查找项目中所有的带有TODO、FIXME、???、!!!标记的注释。通常我们在项目开发中,由于种种原因,一些事情需要以后处理,这个时候为了防止遗忘,加上TODO或FIXME注释是非常有必要的,但是上线或者提交代码前要寻找这些未解决的事项却稍嫌麻烦。XToDo可以提供一个汇总的界面,集中显示所有的未完成的TODO和FIXME标记。
BBUDebuggerTuckAway是一个非常小的工具,可以在你编辑代码的时候自动隐藏底部的调试窗口。因为通常情况下,调试的时候是加断点或监控变量的变化,或者在Console窗口用po来输出一些调试信息。如果开始编辑代码了,说明调试已经结束了,这个时候隐藏调试窗口,可以给编辑界面更多空间,方便我们修改代码。
SCXcodeSwitchExpander能够帮助你迅速地在switch语句中填充枚举类型的每种可能的取值。例如,当你输入switch,然后键入NSTableViewAnimationOptions类时,该插件会将其可能的取值补全在每一个case之后。
deriveddata-exterminator是一个清楚Xcode缓存目录的插件。有些时候Xcode会出现各种奇怪的问题,最常见的是在某些复杂操作下(例如,在同一个项目中,来回切换到各种分支版本),会造成Xcode显示一些编译的错误或警告,但是最终又可以编译通过。新手遇到这种问题常常束手无策,而熟悉Xcode的人就知道,通常清除Xcode缓存就可以解决这类问题。该插件在Xcode菜单上增加了一个清除缓存的按钮,可以方便地一键清除缓存。
ClangFormat是一个自动调整代码风格的工具。Xcode本身的代码缩进自动调整功能比较弱,特别是对于JSON格式,常常产生非常丑陋的默认缩进效果。ClangFormat-Xcode可以更好地对代码进行重新排版,并且内置了各种排版风格,也支持自定义风格。
ColorSense是一个UIColor颜色输入辅助工具,可以帮助你在编写UIColor代码时,实时预览相应的颜色。
XcodeBoost包含多个辅助修改代码的小功能。比如:
可以方便地将.m文件中方法的定义暴露到对应的.h文件中。
可以在某一个源文件中直接输入正则表达式查找。
可以复制粘贴代码时不启用Xcode的自动缩进功能。Xcode的自动缩进经常出问题,造成已经调整好的代码缩进,在粘贴时被Xcode调整坏了。
参考文章:
唐巧的《iOS开发进阶》
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。