xcode自動(dòng)導(dǎo)出API文檔


1.需求

最近在做sdk開發(fā),產(chǎn)品需要API文檔睡蟋,用到了appledoc踏幻,它能夠完美的支持xcode自帶的注釋格式,還支持很多其他格式戳杀,有興趣的自己研究该面,這是一個(gè)非常簡單實(shí)用的開源工具夭苗!

2.安裝appledoc

(1)第一步:下載安裝

git clone git://github.com/tomaz/appledoc.git

cd ./appledoc

sudo sh install-appledoc.sh

(2)第二步:安裝驗(yàn)證:

appledoc--version

3.使用方法

(1)在終端進(jìn)入要導(dǎo)出文檔的工程目錄

cd 項(xiàng)目路徑

(2)輸入下面指令:

appledoc --project-name "項(xiàng)目名字" --project-company "公司名字" ./ 需要掃描的路徑

(3) 項(xiàng)目目錄下會(huì)生成一個(gè)docset-installed.txt文件,打開文本隔缀,復(fù)制里面path题造,通過“前往文件夾”進(jìn)入路徑目標(biāo),找到對應(yīng)的.docset文件猾瘸,通過顯示包內(nèi)容界赔,獲取里面的API文檔。Contents->Resources->Documents

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末牵触,一起剝皮案震驚了整個(gè)濱河市淮悼,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌荒吏,老刑警劉巖敛惊,帶你破解...
    沈念sama閱讀 217,826評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件渊鞋,死亡現(xiàn)場離奇詭異绰更,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)锡宋,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評論 3 395
  • 文/潘曉璐 我一進(jìn)店門儡湾,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人执俩,你說我怎么就攤上這事徐钠。” “怎么了役首?”我有些...
    開封第一講書人閱讀 164,234評論 0 354
  • 文/不壞的土叔 我叫張陵尝丐,是天一觀的道長。 經(jīng)常有香客問我衡奥,道長爹袁,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,562評論 1 293
  • 正文 為了忘掉前任矮固,我火速辦了婚禮失息,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘档址。我一直安慰自己盹兢,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,611評論 6 392
  • 文/花漫 我一把揭開白布守伸。 她就那樣靜靜地躺著绎秒,像睡著了一般。 火紅的嫁衣襯著肌膚如雪尼摹。 梳的紋絲不亂的頭發(fā)上见芹,一...
    開封第一講書人閱讀 51,482評論 1 302
  • 那天校辩,我揣著相機(jī)與錄音,去河邊找鬼辆童。 笑死宜咒,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的把鉴。 我是一名探鬼主播故黑,決...
    沈念sama閱讀 40,271評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼庭砍!你這毒婦竟也來了场晶?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,166評論 0 276
  • 序言:老撾萬榮一對情侶失蹤怠缸,失蹤者是張志新(化名)和其女友劉穎诗轻,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體揭北,經(jīng)...
    沈念sama閱讀 45,608評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡扳炬,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,814評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了搔体。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片恨樟。...
    茶點(diǎn)故事閱讀 39,926評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖疚俱,靈堂內(nèi)的尸體忽然破棺而出劝术,到底是詐尸還是另有隱情,我是刑警寧澤呆奕,帶...
    沈念sama閱讀 35,644評論 5 346
  • 正文 年R本政府宣布养晋,位于F島的核電站,受9級特大地震影響梁钾,放射性物質(zhì)發(fā)生泄漏绳泉。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,249評論 3 329
  • 文/蒙蒙 一陈轿、第九天 我趴在偏房一處隱蔽的房頂上張望圈纺。 院中可真熱鬧,春花似錦麦射、人聲如沸蛾娶。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽蛔琅。三九已至,卻和暖如春峻呛,著一層夾襖步出監(jiān)牢的瞬間罗售,已是汗流浹背辜窑。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留寨躁,地道東北人穆碎。 一個(gè)月前我還...
    沈念sama閱讀 48,063評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像职恳,于是被迫代替她去往敵國和親所禀。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,871評論 2 354