抠脚老汉卖萌失败--关于markdown正确的注释方式

Author Avatar
ieayoio 1月 23, 2018
  • 在其它设备中阅读本文章

Markdown怎么使用注释呢,写在markdown的内容并不想展示出来,怎么做呢?这里:https://www.v2ex.com/t/329205 给了我们一些讨论:

1
2
3
4
5
[comment]: <> (This is a comment, it will not be included)
[comment]: <> (in the output file unless you use it in)
[comment]: <> (a reference style link.)
[//]: <> (This is also a comment.)
[//]: # (This may be the most platform independent comment)

然而这样也能注释:

1
2
3
[^_^]:
commentted-out contents
should be shift to right by four spaces (vim :`>>`).

这已经让我十分震惊了,markdown的注释方式怎么这么萌?!

然而更让我震惊的是@delogn的评论:

1
2
3
4
5
6
7
8
9
10
[^_^]: 
1

[>_<]:
2

[>_>]:
3

都可以用啊,不错不错!以后吐槽和心情都可以写在注释里了!

我试了一下居然真的是!太让人震惊了!!难道这是Markdown的作者在卖萌?!我有点不敢相信Markdown居然会有这样的“语法”,经过我的测试我发现很多颜文字都有注释的作用!我不禁疑惑,为什么??差点以为“语法”就是那么萌,然而,我发现其实中括号中可以添加很多字符都有一些注释的作用,发现类似[xxx]:这样的语法十分类似与上一篇博客中文章末尾指定图片的base64编码的那里很像,这就可以解释为什么颜文字会有注释的作用了,但是使用这种“卖萌注释”真的可行吗?我对他们进行了一些测试内容如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
1.

[^_^]:
abc de
f

g

---

2.

[>_<]:
abcd
defg

---

3.

[>_<]:
abc de

---

4.

[^^]:
abc de
f

g

---

5.

<!--
abc de
f

g
-->

---

6.

<!--
abc de
f

g
-->
hijk

---

在Cmd Markdown中大致显示如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
1.

g

------------------------------------------

2.

defg

------------------------------------------

3.

>_<:
abc de

------------------------------------------

4.

g

------------------------------------------

5.

------------------------------------------

6.

abc de
f

g
-->
hijk

------------------------------------------

有道云笔记大致显示效果如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
1.

abc de f

g

------------------------------------------

2.

defg

------------------------------------------

3.

>_<: abc de

------------------------------------------

4.

abc de f

g

------------------------------------------

5.

------------------------------------------

6.
hijk

------------------------------------------

由cmd Markdown的测试结果可以看到,[^_^]:可以简化为[^^]:具有相同的效果,支持多行注释,但是不能有空行,普通的“颜文字注释”方式不能多行注释,甚至单行都不能有空格,这些“颜文字注释”在有道云笔记下更是面目全非,可以说是非常鸡肋了,这也是之前我为什么说只有“一些”注释的作用了,相比之下,采用html的注释方式<!-- -->更可靠,但是在cmd Markdown下紧临一行如果不是空行,就会造成这种注释方式的失效。

所以,更靠谱的注释方式还是采用<!-- -->比较好,这也是众老汉们卖萌失败(真是可惜),但是最好注释结束空一行比较好。


该博文来自于ieayoio的博客:ieayoio’s blog

本文链接:http://www.ieayoio.com/2018/01/23/关于markdown正确的注释方式/