使用appledoc

安裝

那么簡單介紹一下如何安裝appledoc,安裝非常簡單,只需要2步:

 git clone git://github.com/tomaz/appledoc.git 
 //打開下載的文件夾
 cd appledoc  
 //開始安裝
 sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc  

這樣就安裝完畢了

然后開始生成文檔
命令行輸入

appledoc --no-create-docset --output ~/Desktop --project-name jielindoc --project-company ZQD --company-id com.ZQD ~/Desktop/JieLin6/JieLin6/Helpers/

--no-create-docset //不生成docset類型,生成html
--output ~/Desktop //文檔生成的位置
--project-name jielindoc //工程的名字,其實這個可以隨便取,至少取成工程的名字可以知道這個文檔是哪個
--project-company ZQD
--company-id com.ZQD //公司的id
~/Desktop/JieLin6/JieLin6/Helpers/ //你要生成文檔的注釋類所在的文件目錄,及工程目錄

(個人感覺:剛開始覺得生成蘋果那樣的文檔好牛逼啊,然后花了點時間自己弄了一下,也生成了文檔,但是還是感覺沒有直接看代碼來的快,如果項目代碼框架的寫的好的話自己的代碼就是一個很好的文檔了)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容