C++入门教程(2):注释

小古银的官方网站(完整教程):http://www.xiaoguyin.com/
C++入门教程视频:https://www.bilibili.com/video/av20868986/


当写了很多年代码之后,会逐渐出现以下问题:

  • 很多年前写的代码,现在竟然看不懂,还要重新把代码看一遍。
  • 工作的时候,经常是团队合作,如果别人只发了一大段代码给你用,你看不懂还是要从头看一遍。
  • 你写库的时候,别人看不懂。

等等这些情况。

这时就需要在代码附近写一些文字进行说明,这些文字叫做注释

注意:注释在编译的时候,编译器会将注释去掉,再编译程序,所以注释并不会编译到程序中,不会使程序变慢变大。

先看以下示例:

int main(void)
{
    // 这是行注释, 用来注释一行
    // 编译器会忽略掉注释部分

    /*多行注释*/
    /*注释是用来给人看的,
    例如你写了代码, 半年后发现Bug,
    如果你不写注释, 你会体会到因为看
    不懂代码而从头开始看代码的痛苦了*/
    return 0;
}

看到上面例子,聪明的你肯定也知道怎样写注释了。

如果注释只有一行,在注释前面写//即可;也可以使用/**/在中间写注释。

如果是多行,可以在每行注释前都加上//;也可以使用/**/在中间写很多行注释。

注释的格式有很多种,一般听从项目领导人安排。不过也有几条常用规则的:

  • 不是每行都写注释,在一段小功能的上面写注释,让人一看就知道这小段代码做了什么。
  • 例如变量,别人不知道变量在后面代码中做什么,可以在每个变量右面简短注释这个变量后面是怎么用。
  • 注释都写在需要注释代码的上面和右面。

由于这个C++教程是给初学者看的,所以我基本上会在每行后面添加注释,给初学者说明白。这样,注释就起到它应该有的作用。而实际工作中,都不会是初学者,一些基本的常识并不需要写注释,因为大家都懂,这时写注释反而并不好。多写注释是个好习惯。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,123评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,031评论 2 384
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,723评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,357评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,412评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,760评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,904评论 3 405
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,672评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,118评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,456评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,599评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,264评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,857评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,731评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,956评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,286评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,465评论 2 348