【共读Primer】3.[1.3]注释简介 Page8

最新推荐文章于 2024-06-01 23:59:35 发布

原创最新推荐文章于 2024-06-01 23:59:35 发布 · 114 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#注释 #c++Primer

重读c++primer 同时被 3 个专栏收录

22 篇文章

订阅专栏

c++Primer五版

21 篇文章

订阅专栏

大牛养成计划

21 篇文章

订阅专栏

本文介绍了C++中的两种注释方式及其使用规范。包括单行注释（//）和多行注释（/*...*/），并强调了注释的重要性及避免错误用法。此外，还分享了关于编写有效注释的经验。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

C++的注释有两种

双斜杠开始到本行结束（//）

斜杠星开始星斜杠结束（/）（/）

#include <iostream> // 标准库中输入输出流的库名称
/*
 * 简单主函数：
 * 读取两个数，求它们的和
 */
int main()
{
    std::cout << "Enter two numbers:" << std::endl;// 输出一个提示信息的字符串，并在结尾换行
    int v1 = 0, v2=0;// 声明两个int型的变量，都赋值为0
    std::cin >> v1 >> v2;// 从键盘输入中读取两个数字，分别写入v1和v2两个变量中
    std::cout << "The sum of " << v1 << " and " << v2// 与下一行是一条命令
                   << " is " << v1 + v2 << std::endl;// 输出v1、v2的值，并且输出两数之和的值
    return 0;
}

我们把上次的代码加上一个比较详细的注释。

注释的目的：让代码阅读者更清晰的理解编码者的代码意义。

注释的一种错误用法，/* */的嵌套使用

    /*
     * 注释对 /* */ 不能嵌套。
     * “不能嵌套” 几个字会被认为是源码，
     * 象剩余程序一样处理
     */***
    int main()
    {
       return 0  
    }

从以往的编码经验中得到关于注释的经验有以下几点：

注释并不是越多越好，能很好自解释的代码就没有必要写注释，而对于复杂的算法或逻辑关系应该写清楚
注释最重要的一点是给别人，或者以后的自己看，所以要保证读者能够在尽量短的时间内理解
注释的代码一致性也是很重要的，修改代码的同时一定要修改注释，否则宁愿没有注释