生成头文件注释

Step1. 工具集成


git clonegit://github.com/tomaz/appledoc.git

cd appledoc

sudo sh install-appledoc.sh

Step2. 文档生成

此处可生成两种类型的文档

（1）在Xcode->Window->Documentation and API Reference 目录下

生成Xocde可识别的开发文档，方便在工程中直接查看

命令：

cd “想要生成文档的工程目录”

appledoc -o ./doc --project-name YFSDK --project-company YellFun .（这个.是一定要加的）

（2）生成html文件，可存放在Web页面对外开放

命令：

cd “想要生成文档的工程目录”

appledoc --no-create-docset --output ~/doc --project-name YFSDK --company-id com.yellfun --project-company YellFun .

看看生成的文档的样子吧

（1）在官方的文档目录下面就可以看到、

E1B25907-066C-4992-BCA4-14287645C1C8.png

（2）也可以进到文件里面把Html文件弄出来用浏览器查看

23327C72-B7B8-46A3-8459-4913CB30E768.png

我们点进去瞧瞧

0074D57E-8B94-473A-90F9-2EC305222533.png

PS：我这里直接把生成的Html文件放在的我的Github账号下面了。

借助https://htmlpreview.github.io/?（文档index.html目录）
就可以直接在外网看了、

最后编辑于：2017.12.03 06:24:27