Markdown 注釋

代碼(Bug)時(shí)甜刻,注釋是很重要的呻袭,可以快樂地吐槽而不暴露,可以在代碼之外給你的接任者更進(jìn)一步的誤導(dǎo);

那么寫Markdown怎么能少了這么重要的部分呢蔑担?

總結(jié)了幾個(gè)方法露氮,埋點(diǎn)操作起來。

方式一:Html隱藏

Markdown文檔最終是渲染為html來展示的钟沛,所以可以以如下形式不可見:

<div style="display:none">這是一段注釋</div>

<div style="display: none">如果看到我,說明隱藏失敗</div>

方式二:Xml注釋

<!--
整段整段的不可見內(nèi)容
-->

方式三:Markdown reference Links

Markdown的鏈接(link)基本形式有兩種:

其一為inline

[Inline style](http://example.com/ "標(biāo)題")

其二為reference

[Reference style][id1]

[id1]: http://example.com/ (標(biāo)題)
[id2]: http://example.com/ "標(biāo)題"

reference形式中局扶,鏈接(link)分成了展示部分和引用部分恨统,其中引用(reference)部分是不直接顯示出來的。

如果你經(jīng)常使用Typora進(jìn)行Markdown文檔的寫作的話三妈,應(yīng)該會(huì)發(fā)現(xiàn)Typora通常都是這樣處理鏈接(link)的畜埋,引用(reference)的部分鏈接都放在文檔的最后,可以一定程度上保持主體文檔的簡(jiǎn)潔畴蒲。

到此悠鞍,注釋的形式就很多了:

[comment]: <> (一段注釋)
[comment]: # (一段注釋)
[//]: // (一段注釋)
[//]: 一段注釋

[^_^]: 開心注釋

[>_<]:
  抓狂注釋

[>_>]: #
  (
    斜眼分段注釋
    斜眼分段注釋
    被視為Title,所以要用括號(hào)或引號(hào)框起來
  )

參考

本文完

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末模燥,一起剝皮案震驚了整個(gè)濱河市咖祭,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌蔫骂,老刑警劉巖么翰,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異辽旋,居然都是意外死亡浩嫌,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門补胚,熙熙樓的掌柜王于貴愁眉苦臉地迎上來码耐,“玉大人,你說我怎么就攤上這事溶其∩龋” “怎么了?”我有些...
    開封第一講書人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵握联,是天一觀的道長(zhǎng)桦沉。 經(jīng)常有香客問我,道長(zhǎng)金闽,這世上最難降的妖魔是什么纯露? 我笑而不...
    開封第一講書人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮代芜,結(jié)果婚禮上埠褪,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好钞速,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開白布贷掖。 她就那樣靜靜地躺著,像睡著了一般渴语。 火紅的嫁衣襯著肌膚如雪苹威。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,462評(píng)論 1 302
  • 那天驾凶,我揣著相機(jī)與錄音牙甫,去河邊找鬼。 笑死调违,一個(gè)胖子當(dāng)著我的面吹牛窟哺,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播技肩,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼且轨,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了虚婿?” 一聲冷哼從身側(cè)響起旋奢,我...
    開封第一講書人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎雳锋,沒想到半個(gè)月后黄绩,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡玷过,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年爽丹,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片辛蚊。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡粤蝎,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出袋马,到底是詐尸還是另有隱情初澎,我是刑警寧澤,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布虑凛,位于F島的核電站碑宴,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏桑谍。R本人自食惡果不足惜延柠,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望锣披。 院中可真熱鬧贞间,春花似錦贿条、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至峻仇,卻和暖如春公黑,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背摄咆。 一陣腳步聲響...
    開封第一講書人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工帆调, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人豆同。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像含鳞,于是被迫代替她去往敵國(guó)和親影锈。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354

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

  • Typora中的Markdown 概述 Markdown Daring Fireball創(chuàng)建的蝉绷。最初的指導(dǎo)手冊(cè)....
    謝謝_d802閱讀 6,847評(píng)論 0 2
  • 寫代碼你可以注釋鸭廷,不需要處理的代碼就 comment out。寫 Markdown 呢熔吗?一篇文章寫出來辆床,總是有點(diǎn)草...
    dvorak4tzx閱讀 106,662評(píng)論 17 32
  • 『此文為轉(zhuǎn)載,侵刪桅狠,原文連接在末尾』 代碼可以注釋讼载,不要的代碼可以先 comment out 。 寫 Markdo...
    吐那個(gè)兔弘閱讀 701評(píng)論 0 0
  • MarkDown 注釋 注釋語句 測(cè)試代碼 測(cè)試結(jié)果a e 想了解更多中跌,你可以點(diǎn)擊syntax - Comment...
    V0W閱讀 4,064評(píng)論 0 0
  • Typora的Syntax以此文最好咨堤,摘錄之。 原文:小林記(http://www.reibang.com/p/d...
    comma7456閱讀 2,635評(píng)論 0 2