在很多時候只需寫一個簡要描述就夠了，這時最好使用單行注釋。推薦格式為
// 簡要描述.當需要寫詳細描述時，這時就需要使用多行注釋了。推薦格式為
/** 簡要描述. * * 詳細描述或其他. */對于類（協議、分類）來說，一般只需要寫簡要描述就行了，這時可以使用單行注釋
// 文檔A.@interface DocA : NSObject當需要留下詳細描述時，可換成多行注釋
/** 文檔B. * * 文檔B的詳細描述. */@interface DocB : NSObject簡單的屬性用單行注釋即可
// 數值屬性.@PRoperty (nonatomic,assign) NSInteger num;當需要留下詳細描述時，可換成多行注釋
/** * @brief 字符串屬性. * * 屬性的詳細描述. */@property (nonatomic,strong) NSString* str;對于沒有參數、返回值的簡單方法，可以使用單行注釋
// 簡單方法.- (void)someMethod;若方法具有參數或返回值，這時就得使用多行注釋了
/** * @brief 帶整數參數的方法. * * @param value 值. * * @return 返回value. */- (int)someMethodByInt:(int)value;安裝appledoc十分簡單。打開終端，輸入以下命令
git clone git://github.com/tomaz/appledoc.gitcd appledocsudo sh install-appledoc.sh首先cd到你的項目文件夾下。
–output ./doc：設置輸出目錄為“./doc”。 –project-name objcdoc：設置項目名為“objcdoc”。 –project-company “zyl910”：設置公司名為“zyl910”。 –company-id “cn.com.zyl910”：設置公司id為“cn.com.zyl910”。 .：當前目錄。
當需要html文檔時，可以加上“–no-create-docset”
appledoc --no-create-docset --output ./doc --project-name objcdoc --project-company "zyl910" --company-id "cn.com.zyl910" ~/Desktop/Test/Test/Helpers~/Desktop/Test/Test/Helpers : 掃描指定的文件夾目錄
當該命令完成后，使用瀏覽器打開doc/html/index.html
執行命令之后，在你項目的文件夾中會生成一個doc的文件夾。
1、在你的工程中創建新的 Target，注意這里要選擇 Other 中的 Aggregate，如圖
2、在我們新創建的 Target 中的 Buid Phases 中添加 Run Script
3、打開Run Script，Shell 下面的文檔區域添加這樣的模板
#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}"4、Xcode 左上方選擇這個 Target ，然后 Build 編譯。
5、文檔就會編譯好并且自動安裝進 Xcode 了（重啟Xcode生效）
6、那么編譯之后我們就可以去查看它了，那么在哪里可以看到呢？這時我們就可以用之前生成的 docset-installed.txt文件啦，打開它：看到以一個 Path 了吧：直接復制，然后在 Finder 中前往文件夾。
新聞熱點
疑難解答
