Swift中的文檔注釋

/**
    注釋內(nèi)容如果需要換行需要加空行

    換行

    無(wú)序列表
    - 表1
    - 表2
    - 表3

    1. item1
    2. item2
    3. item3
    
    
    let a = "Hello"
    
*/

/// 另外一種注釋
/// # 
/// ## 一到6級(jí)的標(biāo)題
/// *斜體1* _斜體2_
/// **粗體1**  __粗體2__
/// [標(biāo)題](地址) 超鏈接沐扳、
/// ![標(biāo)題](地址) 圖片
func showMultilineComments() -> String {
    let text = "text"
    return text
}
/// 參數(shù)的域
/// - Parameter item1: item1
/// - Parameter item2: item2

/// - Parameters:
///     - item1: item1
///     - item2: item2
///返回的域
/// - Returns: result
/// 異常的域
/// - Throws: 具體的異常信息
///
func showKeywordsCommentsWithItem(item1: AnyObject?, item2: AnyObject?) throws -> String {
    let text = "text"
    return text
}
///算法
/// - Precondition: 前置條件
/// - Postcondition: 后置條件
/// - Requires:  必要條件
/// - Invariant: 循環(huán)不變量
/// - Complexity: 復(fù)雜度
/// - Important: 重要信息
/// - Warning: 警告信息
/// - Attention: 警告
/// - Note:  記錄
/// - Remark:  評(píng)論
func mysteriousAlgorithm(object: AnyObject) {
    return
}
/// - Author: 作者
/// - Authors: 作者們
/// - Copyright: 版權(quán)信息
/// - Date: 日期
/// - Since: 起始日期
/// - Version: 版本信息
func showMetaComments() -> String {
    let text = "Hello"
    return text
}
/*
 - Road:
 - Touring:
 - Cruiser:
 - Hybrid: 
 - Fixed:
 - Freewheel:
 - style:
 - gearing:
 - handlebar:
 - frameSize:

 - Remark: 高亮某內(nèi)容
 - SeeAlso: `create` 引用代碼

 // MARK: - 標(biāo)記

 // TODO: 將要完成的標(biāo)記

 // FIXME:　留給未來(lái)修改的標(biāo)記

 */
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 人面猴
    序言：七十年代末读慎，一起剝皮案震驚了整個(gè)濱河市，隨后出現(xiàn)的幾起案子议慰，更是在濱河造成了極大的恐慌揩晴，老刑警劉巖蜓洪，帶你破解...
    沈念sama閱讀 206,311評(píng)論 6贊 481
  • 死咒
    序言：濱河連續(xù)發(fā)生了三起死亡事件皮服，死亡現(xiàn)場(chǎng)離奇詭異东臀，居然都是意外死亡着饥，警方通過(guò)查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2贊 382
  • 救了他兩次的神仙讓他今天三更去死
    文/潘曉璐 我一進(jìn)店門惰赋，熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)宰掉，“玉大人，你說(shuō)我怎么就攤上這事赁濒」煅伲” “怎么了？”我有些...
    開(kāi)封第一講書人閱讀 152,671評(píng)論 0贊 342
  • 道士緝兇錄：失蹤的賣姜人
    文/不壞的土叔 我叫張陵拒炎，是天一觀的道長(zhǎng)挪拟。 經(jīng)常有香客問(wèn)我，道長(zhǎng)击你，這世上最難降的妖魔是什么玉组？ 我笑而不...
    開(kāi)封第一講書人閱讀 55,252評(píng)論 1贊 279
  • ?港島之戀（遺憾婚禮）
    正文 為了忘掉前任，我火速辦了婚禮丁侄，結(jié)果婚禮上惯雳，老公的妹妹穿的比我還像新娘。我一直安慰自己鸿摇，他們只是感情好石景，可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5贊 371
  • 惡毒庶女頂嫁案：這布局不是一般人想出來(lái)的
    文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著，像睡著了一般潮孽。 火紅的嫁衣襯著肌膚如雪揪荣。 梳的紋絲不亂的頭發(fā)上，一...
    開(kāi)封第一講書人閱讀 49,031評(píng)論 1贊 285
  • 城市分裂傳說(shuō)
    那天往史，我揣著相機(jī)與錄音变逃，去河邊找鬼。 笑死怠堪，一個(gè)胖子當(dāng)著我的面吹牛揽乱，可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播粟矿，決...
    沈念sama閱讀 38,340評(píng)論 3贊 399
  • 雙鴛鴦連環(huán)套：你想象不到人心有多黑
    文/蒼蘭香墨 我猛地睜開(kāi)眼凰棉，長(zhǎng)吁一口氣：“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼！你這毒婦竟也來(lái)了陌粹？” 一聲冷哼從身側(cè)響起撒犀，我...
    開(kāi)封第一講書人閱讀 36,973評(píng)論 0贊 259
  • 萬(wàn)榮殺人案實(shí)錄
    序言：老撾萬(wàn)榮一對(duì)情侶失蹤，失蹤者是張志新（化名）和其女友劉穎掏秩，沒(méi)想到半個(gè)月后或舞，有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體，經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1贊 300
  • ?護(hù)林員之死
    正文 獨(dú)居荒郊野嶺守林人離奇死亡蒙幻，尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2贊 323
  • ?白月光啟示錄
    正文 我和宋清朗相戀三年映凳，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片邮破。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1贊 333
  • 活死人
    序言：一個(gè)原本活蹦亂跳的男人離奇死亡诈豌，死狀恐怖，靈堂內(nèi)的尸體忽然破棺而出抒和，到底是詐尸還是另有隱情矫渔，我是刑警寧澤，帶...
    沈念sama閱讀 33,701評(píng)論 4贊 323
  • ?日本核電站爆炸內(nèi)幕
    正文 年R本政府宣布摧莽，位于F島的核電站庙洼，受9級(jí)特大地震影響，放射性物質(zhì)發(fā)生泄漏镊辕。R本人自食惡果不足惜油够，卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3贊 307
  • 男人毒藥：我在死后第九天來(lái)索命
    文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望丑蛤。 院中可真熱鬧叠聋，春花似錦撕阎、人聲如沸受裹。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,259評(píng)論 0贊 19
  • 一樁弒父案，背后竟有這般陰謀
    文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)棉饶。三九已至厦章，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間照藻，已是汗流浹背袜啃。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 31,485評(píng)論 1贊 262
  • 情欲美人皮
    我被黑心中介騙來(lái)泰國(guó)打工， 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留幸缕，地道東北人群发。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2贊 354
  • 代替公主和親
    正文 我出身青樓，卻偏偏與公主長(zhǎng)得像发乔，于是被迫代替她去往敵國(guó)和親熟妓。 傳聞我的和親對(duì)象是個(gè)殘疾皇子，可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2贊 345

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