C++ 函数命名中的常见错误

函数命名常常被忽视，但在代码的可读性和维护性方面却至关重要。以下是一些常见的函数命名错误，以及如何避免它们：

1. 函数名称不描述其用途

错误示例：

立即学习“C++免费学习笔记（深入）”；

void foo() { ... }

改进：

void calculate_average(const vector<double>& numbers) { ... }

2. 函数名称过于冗长

错误示例：

立即学习“C++免费学习笔记（深入）”；

double get_the_average_of_numbers(const vector<double>& numbers) { ... }

改进：

double average(const vector<double>& numbers) { ... }

3. 函数名称使用非英语单词

错误示例：

立即学习“C++免费学习笔记（深入）”；

void MostrarMensaje() { ... }

改进：

void show_message() { ... }

4. 函数名称不使用匈牙利命名规范

匈牙利命名规范是一种约定，它使用前缀字符来指示变量和函数的类型和用途。例如：

int nCount;
bool bSuccess;

5. 函数名称使用尖括号

尖括号通常用于模板函数，但对于普通函数来说，它们是不必要的。

错误示例：

立即学习“C++免费学习笔记（深入）”；

void <calculate_average>(const vector<double>& numbers) { ... }

改进：

void calculate_average(const vector<double>& numbers) { ... }

实战案例

考虑以下代码段：

void calculate_average_of_numbers(const vector<double>& numbers) {
  // 计算数字的平均值并返回结果
}

根据上述准则，我们可以对函数名称进行以下改进：

• “calculate_average_of_numbers” 不描述函数的用途。
• 它过于冗长。
• 它没有使用正确的类型前缀。

改进后的函数名称可以是：

double average(const vector<double>& numbers) {
  // 计算数字的平均值并返回结果
}

这个新的函数名称清晰地描述了函数的用途，简短且准确，并且遵循了匈牙利命名规范。