• Index

注释

Reads: 100

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

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

等等这些情况。

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

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

先看以下示例:

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

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

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

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

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

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

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

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


Comments

Make a comment

  • Index

WARNING: You are using an old browser that does not support HTML5. Please choose a modern browser (Chrome / Microsoft Edge / Firefox / Sarafi) to get a good experience.