當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

文档生成器 Xcode与Appledoc

發布時間：2023/12/18 编程问答 23 豆豆

生活随笔收集整理的這篇文章主要介紹了文档生成器 Xcode与Appledoc 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

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

安裝Appledoc

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

其實不用下載的，在github項目的readme中已經寫了安裝方法：

快速安裝

打開終端，輸入：

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

等待完成后繼續輸入：

sudo sh install-appledoc.sh

等待安裝完成。如果出現錯誤，參考后面的錯誤解決

brew安裝

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

brew install appledoc

錯誤解決

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

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

這個問題讓我查了很多資料都沒解決，最后發現可能是新版的brew不能這樣安裝Appledoc（是我的猜測）。

所以決定使用快速安裝。
要注意的是，使用快速安裝要保證/usr/local/bin路徑要存在。如果沒有，一定要手動創建相應的文件夾，并且保證bin文件夾是可讀可寫的（可以在文件夾的『顯示簡介』里更改）

然后就可以放心按照上面『快速安裝』安裝了，不會出現問題。

Appledoc使用

在xcode里使用

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

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

填寫好名字

這樣就添加好了一個Target
然后會彈出一個界面，不同版本長得略有不同
總之選擇Build Phases，點擊左邊的小加號

選擇New Run Script Phase

建好了以后打開剛剛建立的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}"

然后點左上角的項目，發現多了一個Document

點Document，然后再運行，只要沒報錯就OK了
文檔已經編譯好并且自動安裝進Xcode了。重啟xcode，打開documentation。就會發現里面有你剛剛生成的文檔。

如果你想直接看html

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

終端使用

博主還沒有試過，可以先嘗試上面的方法

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

從上到下分別代表的是：

工程名稱

公司名稱

工程ID

生成結果輸出路徑

掃描哪個路徑下的類.

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

轉載于:https://www.cnblogs.com/coderfish/p/4875457.html

總結

以上是生活随笔為你收集整理的文档生成器 Xcode与Appledoc的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。