【iOS】AppleDoc - 利用註解產生文件器

寫技術文件是一件很煩人的事，對於程式設計師真的是一個很大的困擾…

 Appledoc

        產出來的文件(docset、html)會像Apple提供的官方文件的格式，好閱讀，也好保存。

那要如何安裝這好用的工具呢~

要先打開工程師的好朋友 - 終端機(Terminal) ，敲下以下指令：

MibuiMac:~ apple$ git clone git://github.com/tomaz/appledoc.git (利用git下載遠端的執行檔)

MibuiMac:~ apple$ cd appledoc (進入appledoc 內)

MibuiMac:appledoc apple$ sudo sh install-appledoc.sh (安裝appledoc.sh 到電腦中)


米布是沒有遇到Xcode錯誤訊息，可以參考Anistar版大寫的內容

接下來是重頭戲了~

安裝好後，就可以來生文件了。

但前提是必須將註解，先變成Appledoc可以解讀的格式，可以follow Anistar版大寫的內容

appledoc --output /Users/apple/Desktop/Mibu/文案/程式文件 --project-name Test --project-company Mibu --company-id tw.com.mibu --no-warn-undocumented-object --keep-intermediate-files /Users/apple/Desktop/Mibu/程式碼/Test

--output ：輸出文件的位置
--project-name：秀在文件上的專案名
--project-company ：秀在文件上的公司名
--company-id：公司的apple id
--keep-intermediate-files ：需要產生文件的專案資料夾

到輸出的資料夾查看，完成~

參考網址：Anistar