/*
计算x和y的和
函数add接收两个整型参数,返回它们的和
*/
int add(int x, int y)
{
return (x+y);
}
注释要与被注释的内容一致,只能描述被注释的内容,而不能描述其他。注释要放在被注释内容的上方,或者被注释语句的后面,以符合阅读习惯。函数头部应该进行注释,列出函数的功能、可接收的参数、返回值等。要对.h和.cpp文件进行注释,注释应该列出文件名、作者、功能、版本等。对重要的语句、代码块、变量和操作等要给予充分明确的注释。
下面再给出对函数add的完整注释:
/*
* 函数名称:add
* 参 数:接收两个整型参数
* 返回值 :返回整型值
* 函数功能:计算两个整型参数的和并返回其值
* 作 者:周琛
* 版本号 :1.9.1
* 修改日期:2013.5.4
*/
注释的内容可以根据需要酌情增减,但是一定要清晰明确。
代码不仅是写给编译器看的,也是写给其他同事或同行业的人看的。所以在保证程序正确性的前提性下,一定要注意代码的优雅和整洁。这既显示了程序员良好的素养,也显示了其优秀的编程风格。对代码的美化主要通过规范严谨的缩进和必要的注释。
标识符就是为变量、函数、类以及其他用户对象所起的名称。本节主要讲解C++中保留的标识符以及如何定义用户自己的标识符。
保留字是系统预留的符号,这些符号已经被赋予特定的意义。所以程序员只能直接使用它们而不能修改其定义。例如,保留字int和float分别被用来表示整型数据类型和浮点型数据类型,for和while则被用来表示循环语句。标识符的名称可以是一个字符,也可以是多个字符。第一个字符必须是字母或下划线,后跟字母、数字、下划线的组合。标识符区分大小写。长度不得大于32个字符,而通常是前8个字符有效。例如,a、_a、a12等都是标识符。但是1、1a、?a、&a1等都不是合法的标识符。标识符的命名除了满足字符组合方面的原则外,还要遵循下述原则: