1.2.4 注释

程序 Ex_Simple 中的“/*...*/”之间的内容或“//”开始一直到行尾的内容是用来注释的。在 C++中，“/*...*/”是用来实现多行的注释，它是将由“/*”开头到“*/”结尾之间所有内容均视为注释，称为块注释。块注释（“/*...*/”）的注解方式可以出现在程序中的任何位置，包括在语句或表达式之间。而“//”只能实现单行的注释，它是将“//”开始一直到行尾的内容作为注释，称为行注释。

注释的目的只是为了提高程序的可读性，对编译和运行并不起作用。正是因为这一点，所注释的内容既可以用中文来表示，也可以用英文来说明，只要便于理解就行。

一般来说，注释应在编程的过程中同时进行，不要指望程序编制完成后再补写注释。那样只会多花好几倍的时间，更为严重的是，时间长了以后甚至会读不懂自己编写的程序。

通常，必要的注释内容应包含：

（1）在源文件头部进行必要的源程序的总体注释：版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。

（2）在函数的头部进行必要的函数注释：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

（3）其他的少量注释：如全局变量的功能、取值范围等。千万不要陈述那些一目了然的内容，否则会使注释的效果适得其反。