如何在Xcode中創建實例變量和方法的文檔？

Question

我想能夠Alt-Click一個實例變量（或方法）作爲我創建的程序的一部分，並閱讀它的目的是什麼。

事實上，Xcode告訴我類變量聲明在 - 很好，但還不夠。在這種情況下，我希望看到我輸入的自定義文本來描述asset究竟是什麼。此外，還需要了解伊娃的種類。

這怎麼辦？在這種情況下，我不知道究竟我有沒有意思的assets

我特別想知道這信息可以從裏面Xcode，類似中觀看，Eclipse如何顯示JavaDoc內容。

Answer 1

您將需要爲項目創建一個文檔集，並在Xcode安裝。 appledoc可以幫助你。這是一個命令行工具，可以通過頭文件中特殊格式的註釋生成Apple風格的文檔。您還可以通過運行腳本構建階段將它集成到構建過程中，以便文檔始終保持最新狀態。

對於小型項目，通常不值得付出努力，而且您可能最好將註釋添加到頭文件並用Cmd單擊跳轉（Ctrl + Cmd +左箭頭返回到您的位置來自）。

Answer 2

你可能會想看看蘋果的文檔Documentation Sets以及他們的文章generating doc sets using Doxygen。後者是基於Xcode 3.x的，所以它有多大的相關性是有問題的，但儘管如此，仍然是一個好主意。這就是說，如果你決定使用Doxygen（像HeaderDoc這樣的替代品可以用於文檔，但是我不確定你創建的文檔集有什麼可用），它看起來像是你的主要觀點將要把GENERATE_DOCSET=YES放到你的Doxyfile中（或者你決定調用它的任何東西）。之後，您只需將結果放入~/Library/Developer/Shared/Documentation/DocSets（根據Doxygen的文檔）。我不知道這是否適用於Xcode 4.x - 儘管它值得一試，但很高興聽到它。

注意：這大部分是基於Barry Wark的this answer。圖信用在那裏，因爲我不會因爲他的回答而煩惱地看着這個。