寫代碼(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)框起來
)
參考
本文完