第1章 C++预备知识
1.4.2 注释的使用
注释是为了增加程序的可读性和美观，给程序提供注解和备忘录。注解不能太多，也不能太少。太多有碍阅读，太少不利于注解代码。C++中的注释有行注释和块注释两种。行注释用“//”，一次注释一行。块注释用“/* */”，星号中间是被注释的块，可以是多行，也可以是单行。
【示例1-2】 演示单行注释的使用方法。
//计算x和y的和 z=add(x,y);
如果用块注释可以这么写：
当需要注释多条语句时，虽然也可以用多条行注释，但是建议使用块注释。 【示例1-3】 块注释的使用举例。
/*
计算x和y的和
函数add接收两个整型参数，返回它们的和 */
int add(int x, int y) { return (x+y); }
/*计算x和y的和*/
为了写出规整的注释，需要遵循下述几条规则。
? 不要滥用注释，只在必要的地方写注释，注释要准确、易懂、简洁。 ? ? ? ? ?
注释要与被注释的内容一致，只能描述被注释的内容，而不能描述其他。 注释要放在被注释内容的上方，或者被注释语句的后面，以符合阅读习惯。 函数头部应该进行注释，列出函数的功能、可接收的参数、返回值等。 要对.h和.cpp文件进行注释，注释应该列出文件名、作者、功能、版本等。 对重要的语句、代码块、变量和操作等要给予充分明确的注释。
下面再给出对函数add的完整注释。
/*
* 函数名称：add
* 参 数：接收两个整型参数 * 返回值 ：返回整型值
* 函数功能：计算两个整型参数的和并返回其值 * 作 者：XXX * 版本号 ：0.0.1
* 修改日期：XXXX.XX.XX */
注释的内容可以根据需要酌情增减，但是一定要清晰明确，遵循上述几条原则。
·17·
第1篇 面向过程的C++编程
1.4.3 美化代码
代码不仅是写给编译器看的，也是写给其他同事或同行业的人看的。所以在保证程序正确性的前提性下，一定要注意代码的优雅和整洁。这既显示了程序员良好的素养，也显示了其优秀的编程风格。对代码的美化主要通过规范严谨的缩进和必要的注释。
【示例1-4】 寻找3个数中最大数的代码。
/*
* 函数名称：MaxIn3
* 参 数：接收3个整型参数 * 返回值 ：无
* 函数功能：找出3个整型数中较大的数 * 作 者：XXX * 版本号 ：0.0.1
* 修改日期：XXXX.XX.XX */
void MaxIn3(int x,int y,int z) { int num=0; //存放最大数 //选择最大数 if (x>y) { //x较大 if (x>z) num=x; //x是最大数 else num=z; //z是最大数 } else { //y较大 if (y>z) num=y; //y是最大数 else num=z; //z是最大数 } //返回最大数 return num; }
这里给出了一个例程作为参考，读者可以根据自己的需要删减。通常，IDE都回带有专门的格式化代码的工具，也有专门的第三方工具可供使用。但是这些都只是对代码的缩进进行格式化，至于注释还需要自己合理安排和增加。
?技巧：如果希望写出更规范和优美的注释，可以参考开源软件doxygen的格式。该软件提
供了一个内容丰富的风格规范，其更大的好处是可以用该软件将源代码中符合要求的注释导出成文当。
·18·
第1章 C++预备知识
1.5 标 识 符
标识符就是为变量、函数、类以及其他用户对象所起的名称。本节主要讲解C++中保留的标识符以及如何定义用户自己的标识符。
1.5.1 保留字
保留字就是系统已经预定义的标识符，不能再用来定义为其他意义，也被称作关键字。C++中常见的保留字主要有表1-3所示的几种。
表1-3 C++中的常见保留字
_asm catch continue else float inline operator class sizeof throw unsigned abstract while default enum for int private register static true using bool char delete explicit friend long protected return switch try virtual break class do extern goto namespace public short template typedef void case const double false if new struct signed this union volatile 保留字是系统预留的符号，这些符号已经被赋予特定的意义。所以程序员只能直接使用它们而不能修改其定义。例如，保留字int和float分别被用来表示整型数据类型和浮点型数据类型，for和while则被用来表示循环语句。
1.5.2 标识符命名
标识符的名称可以是一个字符，也可以是多个字符。第一个字符必须是字母或下划线，后跟字母、数字、下划线的组合。标识符区分大小写。长度不得大于32个字符，而通常是前8个字符有效。例如，a、_a、a12等都是标识符。但是1、1a、?a、&a1等都不是合法的标识符。标识符的命名除了满足字符组合方面的原则外，还要遵循下述原则。
1．一致性
同一个模块内部的标识符命名要一致。例如，如果规定变量的首字母大写，用全部大写表示常量，那么整个模块内都应该这么写。
2．准确性
用词要准确，可以望文生义，避免概念模糊或形式相近的标识符。例如，定义Total表
·19·
第1篇 面向过程的C++编程
示合计要比随意用一个变量来表示要明确的多。myFun、temp等模糊概念的变量也要避免。
3．长度短，信息多
在保持准确性的前提性，要力争长度短、信息多。既用最短数目的字符数表示尽可能多的信息。例如，用Total表示合计，而不用TotalOfNumbers。
1.6 上 机 实 践
练习使用Visual C++ 6.0开发环境，仿照1.2.4节的步骤，参照1.3.1节上机实现下述程序，并观察其运行情况。
要求：提示使用者从命令行输入3个数，然后按与输入相反的顺序输出。 代码如下所示：
#include 1.7 常见问题及解答 为什么提示标识符非法？ 解答：在1.5.1节中讲到保留字是系统已经预定义的标识符。因此，不能将用做保留字的文字再用于别的用途；否则编译将无法通过。例如，不能将int、struct、sizeof等再用做其他的用途，它们只能表示表1-3中所规定的意义。表1-3列出的只是常见的几种，C++中的保留字比该表要多，有些保留字也很难记。 幸运的是Visual Studio 6.0提供了语法着色功能，该功能可以对C++预定义的对象进行高亮度显示。因此，如果输入一个标识符后，该标识符被高亮度显示，这就说明它是一个保留字，不能用做其他用途。但是，没有被高亮度显示并不意味着就一定能用做自定义的标识符。例如，不能将iostream用做自定义的标识符。从1.3.1节可知，该文字虽然不是保留字， ·20· 第1章 C++预备知识 但却是C++中重要的头文件。因此也不能被用做自定义的标识符。 1.8 小 结 本章主要讲述了C++的一些基本知识，以及编程中需要注意的事项。本书的代码都是在Visual C++ 6.0开发环境下完成的，因此着重讲解了Visual C++ 6.0开发环境及其使用，并给出了一个简单的例子。另外，本章对于C++程序的基本结构和编码中应该注意的规范也给出了说明。标识符是编程中必须要用到的，本章也作了一定的说明。第2章将着重讲解C++中基本数据类型的用法。 1.9 习 题 1．C++中.h文件和.cpp文件有什么用处？ 2．程序中必须有的函数是什么？ 3．C++有几种注释方式，分别表示什么意思？ 4．写出5个合法的变量名称。 5．下面的变量名称是否合法？为什么？ X，x，_，123，_123，a*，char，123a，a b，1aaa，const，int 6．何为保留字？请举例说明。 ·21· 百度搜索“77cn”或“免费范文网”即可找到本站免费阅读全部范文。收藏本站方便下次阅读，免费范文网，提供经典小说教育文库C++入门基础 - 30分钟入门教程(4)在线全文阅读。
相关推荐：