目錄

• 目錄
• 安裝Appledoc
  • 快速安裝
  • brew安裝
  • 錯(cuò)誤解決
• Appledoc使用
  • 在xcode里使用
    • 終端使用

博主是不寫注釋會(huì)死星人，以前 java 的時(shí)候常用 javadoc ，只要寫好注釋，然后用 javadoc 生成html 格式的文檔。用eclipse和myeclipse都能掛上去。
最近的iOS項(xiàng)目是一個(gè)十幾個(gè)人一起寫的項(xiàng)目，很多都初學(xué)者，我寫主要框架這一塊。uml和編碼都搞定了，但是為了協(xié)作給他人使用，需要一份文檔。
除了word和markdown寫的reference，api文檔也是必不可少的。
所以就開(kāi)始搗鼓appledoc。在中間遇到不少問(wèn)題，最后成功的解決了，所以特意分享給大家。

安裝Appledoc

Appledoc的github地址：https://github.com/tomaz/appledoc

其實(shí)不用下載的，在github項(xiàng)目的readme中已經(jīng)寫了安裝方法：

快速安裝

打開(kāi)終端，輸入：

git clone git://github.com/tomaz/appledoc.git

等待完成后繼續(xù)輸入：

sudo sh install-appledoc.sh

等待安裝完成。如果出現(xiàn)錯(cuò)誤，參考后面的錯(cuò)誤解決

brew安裝

如果你裝了brew，Appledoc官方文檔寫的是打開(kāi)終端輸入：

brew install appledoc

---

錯(cuò)誤解決

我試了使用brew安裝，然而顯示錯(cuò)誤：

Error: No available formula for appledoc ==> Searching formulae... ==> Searching taps...

這個(gè)問(wèn)題讓我查了很多資料都沒(méi)解決，最后發(fā)現(xiàn)可能是新版的brew不能這樣安裝Appledoc（是我的猜測(cè)）。

所以決定使用快速安裝。
要注意的是，使用快速安裝要保證/usr/local/bin路徑要存在。如果沒(méi)有，一定要手動(dòng)創(chuàng)建相應(yīng)的文件夾，并且保證bin文件夾是可讀可寫的（可以在文件夾的『顯示簡(jiǎn)介』里更改）

然后就可以放心按照上面『快速安裝』安裝了，不會(huì)出現(xiàn)問(wèn)題。

---

Appledoc使用

在xcode里使用

網(wǎng)上找的很多資料都是在很老版本的xcode中使用appledoc的方法，博主用的是xcode6和xcode7。
首先點(diǎn)擊file->new->target

然后在彈出的界面中選擇Aggregate

填寫好名字

這樣就添加好了一個(gè)Target
然后會(huì)彈出一個(gè)界面，不同版本長(zhǎng)得略有不同
總之選擇Build Phases，點(diǎn)擊左邊的小加號(hào)

選擇New Run Script Phase

建好了以后打開(kāi)剛剛建立的Run Script

把紅框的地方里面替換成：

#appledoc Xcode script # Start constants company="ACME"; companyID="com.ACME"; companyURL="http://ACME.com"; target="iphoneos"; #target="macosx"; outputPath="~/help"; # End constants/usr/local/bin/appledoc \ --project-name "${PROJECT_NAME}" \ --project-company "${company}" \ --company-id "${companyID}" \ --docset-atom-filename "${company}.atom" \ --docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \ --docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \ --docset-fallback-url "${companyURL}/${company}" \ --output "${outputPath}" \ --publish-docset \ --docset-platform-family "${target}" \ --logformat xcode \ --keep-intermediate-files \ --no-repeat-first-par \ --no-warn-invalid-crossref \ --exit-threshold 2 \ "${PROJECT_DIR}"

然后點(diǎn)左上角的項(xiàng)目，發(fā)現(xiàn)多了一個(gè)Document

點(diǎn)Document，然后再運(yùn)行，只要沒(méi)報(bào)錯(cuò)就OK了
文檔已經(jīng)編譯好并且自動(dòng)安裝進(jìn)Xcode了。重啟xcode，打開(kāi)documentation。就會(huì)發(fā)現(xiàn)里面有你剛剛生成的文檔。

如果你想直接看html

可以用Finder進(jìn)入~/Library/Developer/Shared/Documentation/DocSets
看到你的文檔以后可以右鍵查看包內(nèi)容，就可以拿到里面的Html文檔了

終端使用

博主還沒(méi)有試過(guò)，可以先嘗試上面的方法

appledoc --project-name test --project-company "test" --company-id com.test --output /Users/zhoulingyu/Desktop /Users/zhoulingyu/Desktop/Test/Classes

從上到下分別代表的是：

工程名稱

公司名稱

工程ID

生成結(jié)果輸出路徑

掃描哪個(gè)路徑下的類.

---

有什么問(wèn)題都可以在博文后面留言，或者私信，或者微博上找我。
博主主要寫javaee和iOS的。
希望大家一起進(jìn)步。
我的微博：小魚(yú)周凌宇

版權(quán)聲明：本文為博主原創(chuàng)文章，未經(jīng)博主允許不得轉(zhuǎn)載。

轉(zhuǎn)載于:https://www.cnblogs.com/coderfish/p/4875457.html

總結(jié)

以上是生活随笔為你收集整理的文档生成器 Xcode与Appledoc的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。