VVDocumenter + jazzy 自動生成Swift文檔

1狞换,安裝 https://github.com/realm/jazzy

[sudo] gem install jazzy

2, ?使用VVDocumenter插件編寫注釋,

安裝:https://github.com/onevcat/VVDocumenter-Xcode

其他注釋參考:http://nshipster.com/swift-documentation/

3,終端運行:

jazzy --swift-version 2.1.1 --min-acl private | internal | public

-bash: internal: command not found -bash: public: command not found 這兩個提醒不用理會未荒。等待編譯結(jié)束虱肄,工程目錄下有多出docs文件夾李请,打開index.html藤抡,就可以閱讀文檔了

最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市硝枉,隨后出現(xiàn)的幾起案子廉丽,更是在濱河造成了極大的恐慌,老刑警劉巖妻味,帶你破解...
    沈念sama閱讀 223,002評論 6 519
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件正压,死亡現(xiàn)場離奇詭異,居然都是意外死亡弧可,警方通過查閱死者的電腦和手機蔑匣,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,357評論 3 400
  • 文/潘曉璐 我一進店門劣欢,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人裁良,你說我怎么就攤上這事凿将。” “怎么了价脾?”我有些...
    開封第一講書人閱讀 169,787評論 0 365
  • 文/不壞的土叔 我叫張陵牧抵,是天一觀的道長。 經(jīng)常有香客問我侨把,道長犀变,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 60,237評論 1 300
  • 正文 為了忘掉前任秋柄,我火速辦了婚禮获枝,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘骇笔。我一直安慰自己省店,他們只是感情好,可當我...
    茶點故事閱讀 69,237評論 6 398
  • 文/花漫 我一把揭開白布笨触。 她就那樣靜靜地躺著懦傍,像睡著了一般。 火紅的嫁衣襯著肌膚如雪芦劣。 梳的紋絲不亂的頭發(fā)上粗俱,一...
    開封第一講書人閱讀 52,821評論 1 314
  • 那天,我揣著相機與錄音虚吟,去河邊找鬼寸认。 笑死,一個胖子當著我的面吹牛串慰,可吹牛的內(nèi)容都是我干的废麻。 我是一名探鬼主播,決...
    沈念sama閱讀 41,236評論 3 424
  • 文/蒼蘭香墨 我猛地睜開眼模庐,長吁一口氣:“原來是場噩夢啊……” “哼烛愧!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起掂碱,我...
    開封第一講書人閱讀 40,196評論 0 277
  • 序言:老撾萬榮一對情侶失蹤怜姿,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后疼燥,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體沧卢,經(jīng)...
    沈念sama閱讀 46,716評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,794評論 3 343
  • 正文 我和宋清朗相戀三年醉者,在試婚紗的時候發(fā)現(xiàn)自己被綠了但狭。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片披诗。...
    茶點故事閱讀 40,928評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖立磁,靈堂內(nèi)的尸體忽然破棺而出呈队,到底是詐尸還是另有隱情,我是刑警寧澤唱歧,帶...
    沈念sama閱讀 36,583評論 5 351
  • 正文 年R本政府宣布宪摧,位于F島的核電站,受9級特大地震影響颅崩,放射性物質(zhì)發(fā)生泄漏几于。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 42,264評論 3 336
  • 文/蒙蒙 一沿后、第九天 我趴在偏房一處隱蔽的房頂上張望沿彭。 院中可真熱鬧,春花似錦尖滚、人聲如沸膝蜈。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,755評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至非剃,卻和暖如春置逻,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背备绽。 一陣腳步聲響...
    開封第一講書人閱讀 33,869評論 1 274
  • 我被黑心中介騙來泰國打工券坞, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人肺素。 一個月前我還...
    沈念sama閱讀 49,378評論 3 379
  • 正文 我出身青樓恨锚,卻偏偏與公主長得像,于是被迫代替她去往敵國和親倍靡。 傳聞我的和親對象是個殘疾皇子猴伶,可洞房花燭夜當晚...
    茶點故事閱讀 45,937評論 2 361

推薦閱讀更多精彩內(nèi)容

  • afinalAfinal是一個android的ioc,orm框架 https://github.com/yangf...
    passiontim閱讀 15,442評論 2 45
  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理塌西,服務發(fā)現(xiàn)他挎,斷路器,智...
    卡卡羅2017閱讀 134,720評論 18 139
  • Part One 論及“沒有,就去創(chuàng)造”這個話題站辉,我的腦海里便會不由自主地浮現(xiàn)出近期曾積極主動經(jīng)歷過一件事...
    吖坤要加油閱讀 500評論 3 1
  • 精神病的世界觀呢撞,不得不說损姜,精神病想的東西很多,很深殊霞〈菰模看完以后我都開始懷疑我的世界了,我都不知道世界上還有這些人脓鹃,他...
    依米花1993閱讀 514評論 0 0
  • 有人這樣算過瘸右,一個銷售的從初次訪客戶到達成娇跟,中間跟單基本要5-8次才可下單,我想說這個此事確實不多太颤,都是一些剛做銷...
    追風箏的秘密閱讀 387評論 0 0