代碼注釋插件：https://github.com/onevcat/VVDocumenter-Xcode
輸出文檔：https://github.com/tomaz/appledoc
注：需要使用下面格式的注釋才行
/*!
* 字符串拼接
*
* @param aString 需要拼接的字符串
*
* @return 新的字符串
*/
- (NSString *)stringByAppendingString:(NSString *)aString;
或者
/*! 名字 */
@property (nonatomic, copy) NSString *name;
安裝 文檔輸出工具
- 1 下載 appledoc
https://github.com/tomaz/appledoc
- 2 前往文件夾
cd /Users/juyiwei/Desktop/appledoc-master
- 3 安裝
$ sudo sh install-appledoc.sh
以后可以愉快的使用
- 1 先cd 到 項(xiàng)目路徑
cd /Users/juyiwei/Desktop/appledocTest
- 2 輸出
// 簡(jiǎn)寫
appledoc -p XXXX -c "YYYY" --company-id ZZZZ -o ~/doc ./
注：
XXXX：項(xiàng)目名稱
YYYY：公司名稱：主要體現(xiàn)在：Copyright ? 2016 YYYY. All rights reserved. Updated: 2016-04-14
ZZZZ：公司ID：例如com.apple
注2：
文檔存放位置：~/Library/Developer/Shared/Documentation/DocSets
生成的文檔名稱：ZZZZ.XXXX.docset
顯示包內(nèi)容進(jìn)去找到index 的網(wǎng)頁(yè)進(jìn)入文檔主頁(yè)古话。
注 命令說明
appledoc --project-name myproject111 --project-company "surgeyohoo" --company-id www.surge --output ~/doc ./Appledoc
命令說明：
--project-name "項(xiàng)目名稱"
--project-company "公司名稱"
--company-id "工程ID"
--output "生成路徑（親測(cè)無(wú)效陪踩，是我使用方式不對(duì)肩狂？）"
./Appledoc "掃描路徑"
1
