文章目录
  1. 1. 前言 
  2. 2. VVDocmenter-Xcode安装
  3. 3. Alcatraz
  4. 4. Alcatraz安装
  5. 5. Alcatraz卸载
  6. 6. 插件卸载
  7. 7. 展示

前言 

在上一篇中,我记录了对于代码注释的一些研究,然后发现有一些第三方工具Xcode插件可以帮助我们自动地添加代码注释,这里就介绍一种Xcode的插件VVDocmenter-Xcode

引用一下官方的语言,VVDocmenter-Xcode是可以帮助你自主添加生成与appledoc、Doxygen和HeaderDoc这三种文档生成工具都匹配的注释的Xcode插件。而且VVDocmenter-Xcode也是在GitHub上开源的,因此它具有很好的活跃度。

VVDocmenter-Xcode安装

VVDocmenter-Xcode支持Xcode 5以后的版本,而谈到VVDocmenter-Xcode的安装,官方给出了俩种方法,第一种是git clone命令从GitHub上将VVDocmenter-Xcode项目拷贝到本地,然后在本地build以后重启Xcode,之后你就可以在你自己的项目中使用它。

VVDocmenter-Xcode的使用方法也比较简单,在你想要添加注释的位置直接输入三个“/”,VVDocmenter-Xcode就可以帮助你自动识别你想添加的注释的类别,然后生成注释,你只需要将自己的描述加进去就可以了。在这里我们就不在赘述了,官方给出了很好的使用指南。我们在这里重点地讲一下第二种安装方法,就是使用Alcatraz

Alcatraz

Alcatraz是一个开源的Xcode包管理助手,集成了一些可以安装在Xcode内,提高我们开发效率的插件模板配色方案Alcatraz也是支持Xcode 5以后的版本,并且需要在Mac OS 10.9以后的版本才可以正常使用。而关于Alcatraz的安装,在GitHub—-AlcatrazAlcatraz官方网站上都有详细的介绍。  

Alcatraz安装

1
curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh

Alcatraz卸载

1
rm -rf ~/Library/Application\ Support/Developer/Shared/Xcode/Plug-ins/Alcatraz.xcplugin

插件卸载

卸载通过Alcatraz安装的插件、模板和配色方案:

1
rm -rf ~/Library/Application\ Support/Alcatraz/

展示

安装成功之后,我们就可以正常使用Alcatraz来安装VVDocmenter-Xcode啦!!!

文章目录
  1. 1. 前言 
  2. 2. VVDocmenter-Xcode安装
  3. 3. Alcatraz
  4. 4. Alcatraz安装
  5. 5. Alcatraz卸载
  6. 6. 插件卸载
  7. 7. 展示