如何能使xcode拥有自动注释并生成文档的功能

如何能使xcode拥有自动注释并生成文档的功能

      主要分为两步：

      安装Appledoc和配置xcode

        首先说下这两步的关系，安装完Appledoc之后，只要你在代码中按照规定的格式书书写注释，xcode就可以对注释的代码进行解析，用“option+鼠标左键”就可以看到这些注释，如附图：

       但是我们理想的目标是注释的框架能自动生成，而不是自己手动敲上去，所以还需要安装自动注释的插件，配置xcode。

 

 第一部分：安装Appledoc

   分为四小步：

   1.打开终端（即命令行）输入：git clone git://github.com/tomaz/appledoc.git运行结束后，就把该程序clone到本地了。

   2.Appledoc的地址 https://github.com/tomaz/appledoc 这里有Appledoc的最新信息。若地址下不下来，可以从这里获得最新地址

   然后进入程序根目录。

   3.在终端输入：

   cd appledoc

   执行安装sudo sh install-appledoc.sh

   至此，Appledoc就安装成功了。

   4.配置

    在终端输入/usr/local/bin/appledoc\--project-name APPApplications/usr/local/bin/appledoc\--project-name APPApplications\--project--company 公司名称\--company-id 公司ID\--output~/helpappledoc-help

 第二部分：配置xcode。

   从网盘中下载（网盘地址在下边）的安装包，用xcode打开里面的程序，运行，关闭xcode再打开。

   当输入“///”时，系统会自动为代码添加注释的。

 

   网盘地址：http://yunpan.cn/ccFkasI2WX4sM  访问密码 c1ca

   也可以在我上传的资源中找到