一个Xcode插件,VVDocumenter
虽然ObjC代码因为其可读性极强,而不太需要时常查阅文档,但是其实对于大多数人(包括我自己)来说,可能为方法或变量取一个好名字并不是那么简单的事情。这时候可能就需要文档或者注释来帮助之后的开发者(包括大家自己)尽快熟悉和方便修改。但是用Xcode写文档是一件让人很头疼的事情,没有像VS之类的成熟IDE的方便的方法,一直以来都是依靠像Snippet这样的东西,然后自己辛苦填写大量已有的内容。
效果图
怎么样是不是看着听酷炫,挺方便的呢!!!心动就用试试吧
我也摸索了一会才全部搞懂怎么用的,分享一下
①怎么安装
1>使用Alcatraz 按照指引一步步来,然后重启xCode,按F9在列表中找到VVDocumenter-Xcode,点击安装
2>如果你不喜欢用Alcatraz,可以双击VVDocumenter-Xcode.xcodeproj,打开xCode,然后build,plug-in就会自动安装到'~/Library/Application Support/Developer/Shared/Xcode/Plug-ins',重启xCode,在方法前打三个斜杠试试看。
②使用时默认是采用三个斜杠(///)就能自动提取参数等生成规范的Javadoc格式文档注释。如果有想用其他的符号来替代斜杠的,可以再Window>VVDocumenter>Trigger Input实现你的想法
③当前版本的plugin支持到xcode6,如果以后你的xcode要升级的话,plugin就会失效,你需要在VVDocumenter-Xcode-Info.plist的DVTPlugInCompatibilityUUIDs下添加新版本xCode的UUID-verification,查看的方法是/Applications/Xcode.app/Contents/Info.plist里面的DVTPlugInCompatibilityUUID,拷贝之,再重新加载plugin即可。
④此插件也是支持swift的哟!!!