與我的ios項目一起創建幫助文件

我目前正在研究一個項目，我想創建一個幫助文件，但我希望有人可以爲此提出最佳實踐建議。與我的ios項目一起創建幫助文件

幫助文件主要針對我，並且說將來有人可能會接管我的項目等，並且主要是識別我已經實現的對象或代碼段，以及它們的用途等等。

這事我已經在蘋果開發者庫，here發現，但林不知道這是什麼或如何使用它..

2011-12-28 C.Johns

我在一份內部文件項目維基。 – 2011-12-28 03:51:49

是否將一個.txt文件添加到項目中，而不是交互式/足夠同步？當然，你也可以隨時在代碼中添加註釋，但我假設你正在尋找更加鞏固的東西。 – johnluttig 2011-12-28 03:58:55

是的，我認爲它的更多合併和幫助/評論的細節有時在評論中缺乏。 – 2011-12-28 04:24:18

我已經決定去與蘋果HeaderDocs，因爲它已經內置在它產生的結果非常相似於那些與上面列出的應用程序創建的（重：HTML輸出）

它的簡單，你只需要使用結構化你的標題標籤內所發表的意見的

/*! 
@class myclass 
@discussion enter any text here that can span multiple lines etc 
*/

偉大的事情是，你可以發表評論的方法，函數，類，參數等

那麼當你編譯CMD L之內的標題行國家統計局用採集到的頭腳本，將所有的標題註釋合併成一個MasterDoc.html一個目錄中指定，像這樣

>headerdoc2html -o outputdir ExampleHeaders 
>gatherheaderdoc outputdir

親自記錄套房我，因爲我喜歡但是評論我的代碼很多的這種風格我缺乏現在會給我的評論帶來的結構，所以真的是一石二鳥。

唯一的失望，我覺得是，它可能不會像那些這篇文章之前列爲靈活......所以啊，我想用戶prefrence ...現在關閉，以瞭解更多

2011-12-29 02:43:44

你有沒有看着Doxygen？它支持多種語言，並且直接從源代碼中選擇註釋，幫助文檔和源代碼更可能始終保持同步。

Doxygen的支持C++，Ç和目標C開箱。

我個人發現，如果你從良好的doxygen文檔開始，開發人員更可能會選擇並保持最新。

2011-12-28 03:53:45

酷我今晚要檢查一下，我會再等幾個小時再接受任何意見，看看是否有其他人有任何他們可以再次提供hanks。 – 2011-12-28 04:25:31

我試圖現在安裝它，我看不到客觀的c支持。 – 2011-12-28 20:18:59

我更喜歡使用GitHub上提供的appledoc。

它使用Doxygen標記，但輸出html，docsets等格式，看起來就像蘋果的文檔。

Docsets對您很有用，因爲您可以將它們安裝到Xcode中，並在處理代碼時直接提供幫助。

2011-12-28 04:23:25 Abizern

回答