如何使用appledoc生成類似蘋果的文檔

Question

我在閱讀關於如何在here生成類似Apple的HTML文檔的文章。我的問題是命令行的用途。我們如何結合命令行和appledoc xcode項目來生成HTML。

Answer 1

我還沒有使用'appledoc'，但是從快速瀏覽鏈接的頁面看來，它是一個開源的命令行工具。因此，第一步將編譯「appledoc」程序本身，然後將其粘貼到路徑中的目錄中，如/usr/local/bin或​​。

下一步是嘗試使用它來生成一些文檔（假設您已經創建了它所使用的降價文件）。打開一個終端窗口，瀏覽到您的文件所在的目錄，然後用在你的鏈接頁面的頂部給出的命令：

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help . 

如果你想使用「appledoc」再生您的文檔中各個當你創建一個項目時，你可以爲項目中的現有目標添加一個「運行腳本」構建階段，或者爲僅具有「運行腳本」構建階段的文檔創建一個新目標。不管怎樣，該階段的腳本應該是包含類似於上述命令的shell腳本（儘管您可能想明確指定源目錄，而不是僅使用'current'目錄，即.）。

Answer 2

我是appledoc工具的作者。該工具旨在用於上面的Caleb回答。建議的安裝方法是從GitHub克隆存儲庫，在Xcode中打開項目，按照上面的建議構建二進制文件並將二進制文件複製到路徑中。此外，還必須將運行該工具所需的模板文件複製到其中一個預定義路徑。在GitHub的appledoc頁面的自述文件中描述了所需的所有步驟，請參閱快速安裝部分。

還有安裝其他的方法 - 從用戶的所有貢獻：

• 您可以使用包含在git倉庫install-appledoc.sh腳本。
• 也有homebrew配方可用，雖然它不安裝模板文件，我的理解（見this link）。

如有任何其他問題，請轉至appledoc Google group。我剛剛在幾天前創建它，所以在撰寫本文時沒有內容，但可以隨時在那裏提問。

Answer 3

正如我在這個post發現，你可以生成你的代碼中使用此命令行一個完整的HTML文檔：

appledoc --project名BabelCPP --project-公司「我的名字」 - -company-id com.mycompany --no-create-docset --output ./doc/。

最後一個「。」是您的代碼的路徑。