- HeaderDoc
這是一款Xcode自帶的工具,注釋要有嚴格的標準,
比如我創(chuàng)建了一個工程,名字就叫TestDoc,然后再創(chuàng)建一個Target
1.選中你的工程,點擊Add Target按鈕,選擇 Other -> Aggregate模板新建.
2.點擊Add Build Phase按鈕,添加一個Run Script.
編寫以下腳本,跑一遍,當然在這之前,你的注釋文檔應該是有格式化的
mkdir -p headerDoc
find ./TestDoc -name *.h -print | xargs headerdoc2html -o headerDoc
gatherheaderdoc headerDoc
exit 0
- appledoc
如果想要集成進Xcode工程:
1.選中你的工程,點擊Add Target按鈕,選擇 Other -> Aggregate模板新建.
2.點擊Add Build Phase按鈕,添加一個Run Script.
3.把下面的模板代碼復制進去,把前幾行參數(shù)改成你自己的.
4.在Xcode左上角選擇這個新建的Target,然后點擊build.
5.文檔就會編譯好并且自動安裝進Xcode了(重啟Xcode生效).
#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}”
- 凡是以 "http:///"、"/*"或"/!"開頭的注釋塊，都算所appledoc注釋。
- 在注釋塊內(nèi)疟赊，appledoc支持如下語法：Markdown虹脯、HTML赞警、HeaderDoc Tags逸吵。
/**
@brief
這里是方法的簡介。該Tag不能放到類注釋里悠咱。
@exception
UIColorException 這里是方法拋出異常的說明
@see
YYColor
@see
someMethod:
@warning
這里是警告，會顯示成藍色的框框
@bug
這里是bug征炼，會顯示成黃色的框框
@param
red 這里是參數(shù)說明1
@param
green 這里是參數(shù)說明2
@param
blue 這里是參數(shù)說明3
@return 這里是返回值說明
*/
