1.3 注释简介

一、注释的简介:

  注释可以帮助人类读者理解程序。注释通常用于概述算法,确定变量的用途,或者解释晦涩难懂的代码段。编译器会忽略注释,因此注释对程序的行为或性能不会有任何影响。

  虽然编译器会忽略注释,但读者并不会。即使系统文档的其他部分已经过时,程序员也倾向于相信注释的内容是真确可信的。因此,错误的注释比完全没有注释更糟糕,因为他会误导读者。因此,当修改代码时,不要忘记同时更新注释!

二、注释的种类:

  C++中有两种注释:

  1) 单行注释以双斜线(//)开始,以换行结束。当前双斜线右侧的所有内容都会被编译器忽略,这种注释可以包含任何文本,包括额外的双斜线。

  2) 界定符对注释:这种注释继承来自C语言的两个界定符(/*和*/)。这种注释以/*开始,以*/结束,可以包含除*/外的任意内容,包括换行符。编译器讲落在/*和*/之间的所有内容都当作注释。

  注释界定符可以放置于任何允许放置制表符、空格符或换行符的地方。注释界定符可以跨越程序中的多行,单这并不是必须的。当注释界定符跨多行时,最好能显示指出其内部的程序行都属于多行注释的一部分。我们一般采用的风格是,注释内的每行都以一个星号开头,从而指出整个范围都是多行注释的一部分。

  程序中通常同时包含两种形式注释。注释界定符对通常用于多行解释,而双斜线注释常用于半行或单行附住。

 1 #include <iostream>
 2 /*
 3  * 简单主函数:
 4  * 读取两个数,求他们的和
 5  */
 6  int main()
 7  {
 8      // 提示用户输入两个数
 9      std::cout << "Enter two numbers:" << std::endl;
10      int v1 = 0, v2 = 0;    // 保存我们读入的输入数据的变量
11      std::cin >> v1 >> v2;   // 读取输入数据
12      std::cout << "The sum of " << v1 << " and " << v2
13                << " is " << v1 + v2 << std::endl;
14
15      /*
16      // 提示用户输入两个数
17      std::cout << "Enter two numbers:" << std::endl;
18      int v1 = 0, v2 = 0;        // 保存我们读入的输入数据的变量
19      std::cin >> v1 >> v2;        // 读取输入数据
20      std::cout << "The sum of " << v1 << " and " << v2
21                << " is " << v1 + v2 << std::endl;
22      //*/
23
24     return 0;
25  }

  在上面程序中,我们可以看到两种注释符的使用,或者说一般通用使用方法,其中程序的后半段是我特意加上去的,这个主要是用来程序调试时,注释掉我们暂时不需要但后面可能又要用的上的代码,所以不能删除。这里面的注释的精髓在第22行,即在注释界定符(*/)前加入单行注释符(//),这样的好处是,在我们想要进行多行注释时,只需要再我们需要多行注释前加入注释界定符(/*),形成界定符对注释,注释掉中间需要注释的内容。当我们不需要再对他们进行注释时,只需删除注释界定符(/*),而不需要去找后面的另一个注释界定符(*/),因为此时它已经被单行注释掉,这样从而节省我们不少时间及减少出错的几率。

三、注释界定符的注意事项:

  界定符对形成的注释是以/*开始,以*/结束的。因此,一个注释不能嵌套另一个注释之内。编译器对这类问题所给出的错误信息可能是难以理解、令人迷惑的。例如,在我们的的系统中编译下面的程序,就会产生错误:

1 /*
2  * 注释对/* */不能嵌套。
3  * "不能嵌套"几个字会被认为是源码。
4  * 像剩余程序一样处理
5  */
6  int main()
7  {
8      return 0;
9  }
时间: 2024-10-22 14:49:38

1.3 注释简介的相关文章

【共读Primer】3.&lt;1.3&gt;注释简介 Page8

C++的注释有两种 1.  双斜杠开始到本行结束 (//) 2. 斜杠星开始 星斜杠结束 (/*)(*/) 1 #include <iostream> // 标准库中输入输出流的库名称 2 /* 3 * 简单主函数: 4 * 读取两个数,求它们的和 5 */ 6 int main() 7 { 8 std::cout << "Enter two numbers:" << std::endl;// 输出一个提示信息的字符串,并在结尾换行 9 int v1

今天介绍一个渐变的方法,在shell里面自动生成注释简介

在编辑sh脚本时,我经常在shell中写一些注释.今天我介绍一种渐变方法,它可以在每次vim shell脚本时自动在shell中生成注释和其他信息. 让我们共享一个shell脚本模板文件,将其复制到用户的主目录并将其命名为.vimrc名称,以便我们在打开以.sh结尾的文件时自动生成一些注释信息,只需稍微修改即可. 这很方便吗?让我们为您分享代码,然后将以下文件粘贴到您自己的要求中,并根据您自己的要求进行更改.保存并退出. 编辑后,我发现ls看不到这个文件,因为它变成了一个隐藏文件,可以查看ll

Hibernate---数据操作示例BY实体类注释

通过实体的映射文件创建表的示例,所需jar包如下 antlr-2.7.7.jar: dom4j-1.6.1.jar geronimo-jta_1.1_spec-1.1.1.jar: hibernate-commons-annotations-5.0.1.Final.jar: hibernate-core-5.0.12.Final.jar: hibernate-jpa-2.1-api-1.0.0.Final.jar: jandex-2.0.0.Final.jar: javassist-3.18.1

前端开发神器sublime Text

实用的sublime插件集合 – sublime必备插件 前言 入前端领域开始,就学着使用sublime,一直用起来很顺手,速度是我最欣赏的,快的没有编辑器可以匹敌.还是废话不多扯,入正题.好多有多少,用了就知道了. 插件介绍 Package Control 功能:安装包管理 简介:sublime插件控制台,提供添加.删除.禁用.查找插件等功能 使用:https://sublime.wbond.net/installation 安装方法: CTRL+` ,出现控制台 粘贴以下代码至控制台 ST2

C++ Primer 第五版:第1 章

*****C++ Primer 第五版第1章学习笔记***** *****实验代码在Red Hat 6.6或VS 2013中调试***** *****文章内容依据当前知识撰写,存在认识的局限性***** 1.1 编写一个简单的C++程序 函数:依据我个人理解,C/C++的函数是一个能够完成一个功能的模块. 完整函数的组成: ①返回类型:不一定有返回值,故不一定有返回类型 ②函数名:根据名字标识完成特定功能的模块,必须存在 ③形参列表:可能没有参数传入,不一定存在 ④函数体:一个完整的函数应该是有

C++ Primer第一章(submit 转换格式)

1 ********************************************************************** 2 C++ Primer第一章 笔记 3 ********************************************************************** 4 序言(书籍推荐): 5 1.<C++标准程序库> 6 2.Scott Meryers <Effective C++> 7 3.Anothony Will

转一篇sublime必备的一些插件

Package Control 功能:安装包管理 简介:sublime插件控制台,提供添加.删除.禁用.查找插件等功能 使用:https://sublime.wbond.net/installation 安装方法: CTRL+` ,出现控制台 粘贴以下代码至控制台 ST2: import urllib2,os; pf='Package Control.sublime-package'; ipp = sublime.installed_packages_path(); os.makedirs( i

JAVA 基础 (一)

Java 程序注释: 1. //:用于单行注释.Eclipse 下 快捷键:Ctrl+/ 2. /*...*/:用于多行注释 快捷键:Ctrl+Shift+/    关闭:Ctrl+Shift+\ 3./**...*/: doc 注释.主要是为了支持JDK工具Javadoc而采用的.Javadoc能识别注释中用标记"@"标识的一些特殊变量,并把doc注释加入它所生成的html文件. Eclipse添加注释简介: window--preferences--java--Code Templ

js/jquery/html前端开发常用到片段代码(一直更新着)

1.IE条件注释 条件注释简介 IE中的条件注释(Conditional comments)对IE的版本和IE非IE有优秀的区分能力,是WEB设计中常用的hack方法.条件注释只能用于IE5以上,IE10以上不支持. 如果你安装了多个IE,条件注释将会以最高版本的IE为标准. 条件注释的基本结构和HTML的注释(<!– –>)是一样的.因此IE以外的浏览器将会把它们看作是普通的注释而完全忽略它们. IE将会根据if条件来判断是否如解析普通的页面内容一样解析条件注释里的内容. 条件注释使用方法示