18. 代码规范与注释
在编写代码时，遵循一定的规范和使用恰当的注释是非常重要的。良好的代码规范可以让代码更易读、易维护，而注释则能帮助他人（也包括未来的自己）理解代码的功能和逻辑。接下来，我们将详细介绍C++编程中一些常用的代码规范和注释方法。
18.1 缩进、空格与命名规范
18.1.1 缩进
缩进是指在代码行的开头添加空格或制表符，以此来展现代码的层次结构。在C++里，通常使用 4 个空格或者 1 个制表符进行缩进。以下是一个示例：
#include <iostream>
int main() {
// 主函数代码块开始，缩进 4 个空格
if (true) {
// if 语句代码块开始，再次缩进 4 个空格
std::cout << "This is inside the if statement." << std::endl;
}
return 0;
}
合理的缩进能让代码的层次结构一目了然，方便阅读和理解。
18.1.2 空格
空格在代码中起到分隔不同元素的作用，能增强代码的可读性。以下是一些空格的使用规则：
- 运算符两侧：在运算符（如
+、-、*、/等）两侧添加空格。
int result = 5 + 3; // 运算符 + 两侧有空格
- 逗号后面：在逗号后面添加空格。
void printNumbers(int a, int b) { // 逗号后面有空格
std::cout << a << ", " << b << std::endl;
}
- 函数参数列表：在函数参数列表中，参数之间用逗号分隔，并且在逗号后面添加空格。
void calculate(int num1, int num2) { // 参数之间有空格
// 函数体
}
18.1.3 命名规范
良好的命名规范能让变量、函数和类的名称具有明确的含义，方便理解代码的功能。以下是一些常见的命名规范：
- 变量命名：使用有意义的名称，采用小写字母和下划线组合的方式，例如
student_name、age。
int student_age = 15; // 变量名具有明确含义
- 函数命名：使用动词和名词组合的方式，采用小写字母和下划线组合，例如
calculate_area、print_info。
void print_student_info() { // 函数名表明了函数的功能
// 函数体
}
- 类命名：采用大写字母开头的驼峰命名法，例如
Student、Rectangle。
class Rectangle { // 类名采用大写字母开头的驼峰命名法
// 类的成员
};
18.2 单行与多行注释的使用
18.2.1 单行注释
单行注释以//开头，用于对某一行代码或一小段代码进行简要说明。
// 定义一个整数变量，并初始化为 10 int num = 10; // 调用函数打印信息 print_student_info();
18.2.2 多行注释
多行注释以/*开头，以*/结尾，用于对一段代码或一个函数进行详细说明。
/*
* 这个函数用于计算矩形的面积
* 参数:
* length - 矩形的长度
* width - 矩形的宽度
* 返回值:
* 矩形的面积
*/
int calculate_rectangle_area(int length, int width) {
return length * width;
}
18.3 实践：互评代码，找出不规范之处
现在，让我们通过一个实践活动来巩固所学的代码规范知识。下面是一段不规范的代码，你可以和你的同学互相交换代码，找出其中的不规范之处，并尝试进行修改。
#include <iostream>
int main(){
if(true){
std::cout<<"This is inside the if statement."<<std::endl;
}
return 0;
}
不规范之处分析：
- 缩进问题：代码块没有进行缩进，无法清晰地展现代码的层次结构。
- 空格问题：
if语句和main函数的括号前后没有空格，运算符<<两侧也没有空格。
修改后的代码：
#include <iostream>
int main() {
if (true) {
std::cout << "This is inside the if statement." << std::endl;
}
return 0;
}
18.4 总结
遵循代码规范和正确使用注释是编写高质量代码的基础。通过合理的缩进、空格使用和命名规范，以及恰当的注释，代码的可读性和可维护性将得到显著提升。在今后的编程学习中，要养成良好的编码习惯。
18.5 课后练习
- 找出以下代码中的不规范之处，并进行修改：
#include <iostream>
void printMessage(int a,int b){
std::cout<<a+b<<std::endl;
}
int main(){
printMessage(5,3);
return 0;
}
- 为以下代码添加适当的注释，解释代码的功能和逻辑：
#include <iostream>
int calculateSum(int num1, int num2) {
return num1 + num2;
}
int main() {
int result = calculateSum(10, 20);
std::cout << "The sum is: " << result << std::endl;
return 0;
}
- 编写一个函数，用于计算两个数的乘积，并遵循代码规范和添加适当的注释。