使用appledoc生成第三方庫的API

目前，很多第三方庫都支持使用AppleDoc創(chuàng)建對應(yīng)的API文檔。你可以到第三方庫的github頁面去了解其是否支持appledoc以及相關(guān)的doc生成命令。

安裝appledoc

//在terminal中輸入
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh

//安裝完成后，驗(yàn)證下是否成功
appledoc --version

生成文檔

1. 先去github下載第三方庫的源碼。(git clone XXX.git)
2. cd到第三方庫所在目錄。
3. 在terminal中執(zhí)行生成doc的命令。下面以AFNetworking為例(命令都可以對應(yīng)的github頁面上找到)

appledoc --project-name="AFNetworking" --project-company="AFNetworking" --company-id="com.afnetworking.afnetworking" AFNetworking/*.h

4. 然后就可以用dash查看文檔了。

參考

用 appledoc 生成文檔

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容