前言:
網上很多關于appledoc的使用,要么比較久的,要么講解的不是很清晰,按照他們的步驟執行沒成功,so,根據自己安裝使用成功和遇到的問題,記錄一下:
背景:
項目源碼交接給另外一個公司的開發人員,需要為他們提供app大致的使用文檔,CTO問:你們是否有類似java的javadoc源碼文檔工具,百度了一下:答案是有的,iOS也有appledoc,而且appledoc最后生成一個indxe.html文件,打開index.html文件會顯示iOS官方API一樣風格的文檔,是不是還蠻棒棒的!
體驗:
安裝:打開終端一步步執行下面的命令
$ git clone git://github.com/tomaz/appledoc.git
$ cd ./appledoc
$ sudo sh install-appledoc.sh
驗證:安裝是否成功
# 查看版本,如果顯示版本,則證明安裝成功
$ appledoc --version
# 查看appledoc的命令
$ appledoc --help
appledoc --version
使用:重點來拉,認真執行下面這三個步驟就行,看清截圖
- 1、創建一個Xcode項目,項目名:demo,并創建一個文件測試生成文檔;
- 2、cd 到項目文件夾;
- 3、執行終端命令
具體步驟: -
1、創建一個Xcode項目,項目名:demo,并創建一個文件測試生成文檔:
SoundBusTool類 - 2、cd 到項目文件夾:
cd 到項目的文件夾
項目目錄
- 3、執行終端命令
$ appledoc --no-create-docset --output="./doc" --project-name="工程名" --company-id="bundle id" --project-company="公司名" .
執行終端命令
打開index.html文件
查看文檔
遇到的兩個問題:
-
問題1:執行終端命令doc文件夾下沒有生成index.html文件,原因是:沒有給Xcode創建的demo項目寫注釋,解決,如果我在appdelegate.h中,隨便給方法添加一個注釋,然后在執行終端命令就能成功生成index.html文件;
問題1錯誤提示docsetutil:
解決1 -
問題2:在原來的項目中,執行命令,沒有生成doc文件夾;
問題2錯誤提示:Invalid parameter not satisfying: [arguments count] >= 1
解決2