## 注释
注释文本无论在哪种语言中都尤为重要。你可以用它来向其他人说明你代码的用意,也可以用来给自己做提醒。
注释在代码运行时不会被执行。
注释方法是`/* */`或者`//`。
使用`/* */`注释的语法是这样的:
>[info] /* 我是注释 */
你可以跨行注释:
>[info] /* 我是第一行注释
>我是第二行注释
>我是第三行注释 */
你也可以使用`//`注释。**一行内**`//`后面的字符都会视为注释:
>[info] {"你好","你也好"} //我是注释
>[danger] **注意!** 请不要把这些内容写在注释里:
> * 个人隐私信息
> * 用户名、邮箱等留名式信息(贡献信息会自动附加,请不要手动附加您的用户名等信息)
> * 无关紧要的信息,比如“今天天气真好”之类
> * 会干扰代码执行的注释
> * 对他人阅读代码产生干扰的注释
> * 会使代码运行缓慢臃肿的注释
注意:注释部分的内容不计入贡献。
### 正确的例子
~~~
{
("你好呀", "你最近怎么样"),
(LINK_A) // LINK_A 指向的是37行的回答
endl;
}
~~~
~~~
{
("你好呀", "你最近怎么样"),
(LINK_B)
endl;
}
/* LINK_B 指向的是49行的回答,
LINK_B下只有一个回答 */
~~~
### 反例
1. 用户名、邮箱等留名式信息(贡献信息会自动附加,请不要手动附加您的用户名等信息)
~~~
{
("你好呀", "你最近怎么样"),
(LINK_C) // 这段是我Example写的!!
endl;
}
~~~
2. 无关紧要的信息,比如“今天天气真好”之类
~~~
{
("你好呀", "你最近怎么样"),
(LINK_D) // 今天天气还行
endl;
}
~~~
3. 对他人阅读代码产生干扰的注释
~~~
{/* 呵呵 */
/* 呵呵 */
("你好呀", "你最近怎么样"),/* 呵呵 */
(LINK_E)/* 呵呵 */
endl;/* 呵呵 */
}/* 呵呵 */
~~~
4. 会干扰代码执行的注释
~~~
{
("你/*断*/好/*断*/呀", "你最/*断*/近怎/*断*/么样"),
(LINK_/*断*/F)
en/*断*/dl;
}
~~~
5. 会使代码运行缓慢臃肿的注释
~~~
{
("你好呀", "你最近怎么样"),
(LINK_G)
endl;
}
/* 我认为“你好呀”这句话和长恨歌有很大的联系
汉皇重色思倾国,御宇多年求不得。
杨家有女初长成,养在深闺人未识。
天生丽质难自弃,一朝选在君王侧。
......(省略好多好多好多行)
在天愿作比翼鸟,在地愿为连理枝。
天长地久有时尽,此恨绵绵无绝期。*/
~~~