已使用插件
包管理插件： Alactraz
安裝地址: ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins
文檔注釋: VVDocumenter
使用Alactraz包管理插件安裝
其他插件參考
文檔注釋: github優(yōu)秀開源項目大全-iOS
"github優(yōu)秀開源項目大全-iOS"
文檔生成
使用appledoc生成文檔。
- appledoc安裝:appledoc
- Xcode和appledoc 集成:
https://github.com/tomaz/appledoc/blob/master/XcodeIntegrationScript.markdown
- 利用xcode自動生成項目文檔: 跳轉(zhuǎn)地址
- 可執(zhí)行Run script 代碼塊
# shell script goes here
#appledoc Xcode script
# Start constants
company="9tong";
productName="人脈通";
companyID="com.9tong";
#outputPath="~/help";
outputPath="./doc";
inputPath="./tranb/class/ViewController/Home/Tranb/TimeLine";
# End constants
/usr/local/bin/appledoc \
-p "${productName}" \
-c "${company}" \
--company-id "${companyID}" \
--no-create-docset \
-o "${outputPath}" \
"${inputPath}"
exit 0
使用HeaderDoc生成文檔。
- 利用xcode自動生成項目文檔: 跳轉(zhuǎn)地址
2.可執(zhí)行Run script 代碼塊
# shell script goes here
mkdir -p headerDoc
find ./tranb/class/ViewController/Home/Tranb/TimeLine -name \*.h -print | xargs headerdoc2html -o headerDoc
gatherheaderdoc headerDoc
exit 0
3.headerDoc文檔注釋規(guī)范鏈接地址
