/*
這里只作簡單描述哦,具體詳細(xì)了解
請(qǐng)前往https://github.com/tomaz/appledoc
*/
Step1. 工具集成
git clonegit://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
Step2. 文檔生成
此處可生成兩種類型的文檔
(1)在Xcode->Window->Documentation and API Reference 目錄下
生成Xocde可識(shí)別的開發(fā)文檔,方便在工程中直接查看
命令:
cd “想要生成文檔的工程目錄”
appledoc -o ./doc --project-name YFSDK --project-company YellFun .(這個(gè).是一定要加的)
(2)生成html文件,可存放在Web頁面對(duì)外開放
命令:
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)也可以進(jìn)到文件里面把Html文件弄出來用瀏覽器查看
23327C72-B7B8-46A3-8459-4913CB30E768.png
我們點(diǎn)進(jìn)去瞧瞧
0074D57E-8B94-473A-90F9-2EC305222533.png
PS:我這里直接把生成的Html文件放在的我的Github賬號(hào)下面了蠢古。
借助https://htmlpreview.github.io/?(文檔index.html目錄)
就可以直接在外網(wǎng)看了、