1.需求
最近在做sdk開發(fā),產(chǎn)品需要API文檔睡蟋,用到了appledoc踏幻,它能夠完美的支持xcode自帶的注釋格式,還支持很多其他格式戳杀,有興趣的自己研究该面,這是一個(gè)非常簡單實(shí)用的開源工具夭苗!
2.安裝appledoc
(1)第一步:下載安裝
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
(2)第二步:安裝驗(yàn)證:
appledoc--version
3.使用方法
(1)在終端進(jìn)入要導(dǎo)出文檔的工程目錄
cd 項(xiàng)目路徑
(2)輸入下面指令:
appledoc --project-name "項(xiàng)目名字" --project-company "公司名字" ./ 需要掃描的路徑
(3) 項(xiàng)目目錄下會(huì)生成一個(gè)docset-installed.txt文件,打開文本隔缀,復(fù)制里面path题造,通過“前往文件夾”進(jìn)入路徑目標(biāo),找到對應(yīng)的.docset文件猾瘸,通過顯示包內(nèi)容界赔,獲取里面的API文檔。Contents->Resources->Documents