appledoc
2.2.1 build 1333
重要通知：需要合作者
appledoc 是命令列工具，可協助 Objective-C 開發人員從特殊格式的原始碼註解產生類似 Apple 的原始程式碼文件。它的設計目的是為了輸入盡可能可讀的源代碼註釋，並使用註釋以及周圍的源代碼來生成 HTML 形式的視覺上吸引人的文檔以及完全索引和可瀏覽的 Xcode 文件集。儘管有多種工具可以為 Objective-C 建立 HTML 文檔，但據我所知，所有這些工具都無法滿足下面描述的最低目標。
appledoc 的主要目標：
為了讓您盡可能順利地使用 appledoc，我們強烈建議您閱讀整個文件以及下面「使用 appledoc」部分中提到的所有線上文件！
根據本文件底部「許可證」部分列出的條款，允許使用 appledoc！
想要保持更新嗎？在 Twitter 上關注我們 - @gentlebytes。
建議的方法是複製 GitHub 專案並從 Xcode 編譯工具。由於克隆 GitHub 專案將創建主存儲庫的鏈接，因此它也極大地簡化了未來的升級。若要安裝，請在終端機中鍵入以下內容：
git clone git://github.com/tomaz/appledoc.git
這將建立 appledoc 目錄。在其中您可以找到 appledoc.xcworkspace Xcode 工作區；打開它並編譯 appledoc 目標 - 這應該可以開箱即用，但是您的系統必須滿足最低系統要求，請參見下文。我建議您將產生的 appledoc 可執行檔從建置目錄複製到路徑中的目錄之一（ echo $PATH ），以使其易於存取。
可選：Appledoc 是獨立的，包含必要的範本文件。如果您想要將這些預設值從 Templates 子目錄修改到預期位置之一：
您也可以使用 install-appledoc.sh 腳本來執行快速安裝。開啟終端並切換到 appledoc 目錄。鍵入以下命令：
sudo sh install-appledoc.sh (if you need templates add '-t default')
預設情況下，它編譯 appledoc 並將其二進位檔案安裝到 /usr/local/bin 並將範本（如果需要）安裝到 ~/.appledoc 。您可以分別使用 -b 和 -t 選項覆寫此目錄。例如：
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
或使用自製程序：
brew install appledoc
Homebrew 預設不安裝模板。
使用appledoc --help查看所有命令列開關的清單。在 appledoc 網站上閱讀更多關於 appledoc 的資訊。也請閱讀 wiki 頁面以獲取一些更深入的文章。
使用 appledoc Google 群組作為有關使用問題或其他一般問題的論壇。
使用 appledoc 問題頁面提交錯誤和功能請求。在提交新問題之前，請檢查論壇，看看您的問題是否在那裡得到解答- 除非您可以確認您的問題是新功能請求或錯誤，否則您應該從論壇開始，以保持GitHub 問題的乾淨。請同時仔細閱讀問題，看看該問題是否已經存在，並對其進行投票或添加評論（不要忘記已關閉的問題）。
要保持最新狀態，只需轉到終端機並 cd 進入 appledoc 目錄，發出git pull並重新編譯 appledoc.xcodeproj。不要忘記覆蓋您複製到 $PATH 的 appledoc 可執行檔:)
如果您還想編譯並執行 AppledocTests（單元測試）目標，則需要在建置單元測試目標之前將 Libraries & Frameworks 群組中指示的所有框架複製到共用框架目錄！這對於建立 appledoc 工具本身來說並不是必需的。
您可以設定 Xcode 來自動建立 appledoc 文件。了解如何使用運行腳本和專案的建置階段。
大多數 Cocoa 框架的預生成文件和文件集可在以下位置找到：
擁有文件集後，您可能希望將其與文件瀏覽器一起使用：
有問題嗎？您可以執行以下操作來排除故障：
git pull並再次使用最新版本運行。--verbose命令列開關增加詳細等級。預設等級為 2，但您可以逐步將詳細程度增加到 6，每個等級都會為您提供更詳細的資訊。由於這將為您提供更多信息，因此您可能只想專注於遇到問題的特定來源文件集。請注意，增加詳細程度會導致效能下降，因此不建議每天使用高於 4 的等級。如果您希望做出貢獻，請參閱開發人員說明文件，以取得 appledoc 內部運作原理的簡短概述。
appledoc 已取得修改後的 BSD 授權的許可。用簡單的語言來說：您可以對程式碼做任何您想做的事情，修改，重新分發，嵌入您的產品（免費或商業），但您必須包含許可證中規定的版權，使用條款和免責聲明，同樣與任何其他 BSD 許可代碼一樣。您當然可以使用 appledoc 為您的產品產生的文件（免費或商業），但您必須在文件本身或其他適當的位置（例如您的網站）中註明 appledoc。
如果您出於某種原因無法同意這些條款，請透過我們的「關於」頁面上的聯絡表單與我們聯繫，我們將盡力幫助您並找到可行的解決方案！
版權所有 (c) 2009-2011，Gentle Bytes 保留所有權利。
如果滿足以下條件，則允許以原始程式碼、二進位形式和產生的文件（無論是否經過修改）重新分發和使用：
原始碼的重新散佈必須保留上述版權聲明、此條件清單和以下免責聲明。
以二進位形式重新散佈必須在隨散佈提供的文件和/或其他資料中複製上述版權聲明、此條件清單以及以下免責聲明。
由 appledoc 產生的文件的重新分發必須包含 appledoc 的歸屬，無論是在文件本身還是其他適當的媒體中。
未經事先書面許可，不得使用 appledoc、Gentle Bytes 及其貢獻者的名稱來認可或推廣源自本軟體的產品。
本軟體由版權所有者和貢獻者「按原樣」提供，不承擔任何明示或默示的保證，包括但不限於適銷性和特定用途適用性的默示保證。在任何情況下，版權持有者或貢獻者均不對任何直接、間接、附帶、特殊、懲戒性或後果性損害（包括但不限於採購替代商品或服務；使用、數據或利潤損失；或其他損失）承擔責任。被告知可能發生此類損害。
溫和位元組 [email protected]
