iOS 生成docset文档

安装appledoc

git clone https://github.com/tomaz/appledoc.git
cd appledoc
sudo sh --install-appledoc.sh

使用appledoc生成注释文档

appledoc --output <输出路径> --project-name "工程名" --project-company "公司名字" --company-id "公司ID" .

我在这用的命令是：

appledoc --output ~/Desktop/FunctionDoc --project-name "FountionTest" --project-company "FountionTestCompany" --company-id "FTC" .

注意最后的点一定要有。

文档生成后查看输出路径下的 FunctionDoc，里面只有一个 .txt 文件

FunctionDoc.png

打开txt文件，里面显示内容如下：

Documentation set was installed to Xcode!

Path: /Users/user/Library/Developer/Shared/Documentation/DocSets/FTC.FountionTest.docset
Time: 2017-06-14 03:48:45 +0000

前往TXT文件所示路径下

FountionTest_docset.png

右键“显示包内容”，打开 /Contents/Resources/Documents/index.html ，查看文档，如下：

Function_Document.png