C++ 命名约定

2024 年 8 月 28 日 | 阅读 9 分钟

C++ 有一套关于在代码中命名变量、函数和其他标识符的规则。这些规则被称为命名约定，有助于使您的代码更具可读性和可维护性。

C++ 命名约定指南

变量名应具有描述性且有意义。例如，保存班级学生数量的变量可以命名为“numStudents”或“studentCount”。

变量名应使用小写字母，单词之间用下划线分隔。例如，“student_count”或“total_income”。

函数名应使用驼峰命名法（camelCase），除了第一个单词的首字母外，每个单词的首字母都大写。例如，“calculateTotalIncome”或“getStudentCount”。

常量名应使用全大写字母，单词之间用下划线分隔。例如，“PI”或“MAX_STUDENT_COUNT”。

类名应使用帕斯卡命名法（CamelCase），每个单词的首字母都大写。例如，“Student”或“CourseEnrollment”。

避免使用其他程序员可能不熟悉的缩写或首字母缩略词。

避免使用保留字或关键字作为变量或函数名。

C++ 代码（命名约定）

#include <iostream>
// PascalCase is often used for function names
void PrintGreeting() {
  std::cout << "Hello, world!" << std::endl;
}
int main() {
  // camelCase is often used for variable names
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;
 // Some people use prefixes or suffixes to indicate the type of a variable
  // (such as "str" for strings or "arr" for arrays)
  std::string strCustomerName = "John Smith";
  int arrScores[10] = {0};

  // Other people use ALL_CAPS for constants
  const int MAX_CUSTOMERS = 100;
  // Some people use underscores to separate words in variable names
  int num_customers = 10;
  double avg_sale_amount = 25.50;
  std::string customer_name = "John Smith";
  // Finally, some people use Hungarian notation, where the type of a variable
  // is indicated by the first few letters of its name (such as "i" for int,
  // "d" for double, or "str" for string)
  int iCount = 0;
  double dTotal = 0.0;
  std::string strName = "";
  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  std::cout << "Number of customers: " << num_customers << std::endl;
  std::cout << "Average sale amount: " << avg_sale_amount << std::endl;
  std::cout << "Customer name: " << customer_name << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.
Number of customers: 10
Average sale amount: 25.5
Customer name: John Smith

命名约定的优点

以下是使用一致的 C++ 命名约定的每个优点的示例

提高可读性：使用一致的命名约定可以通过查看变量或函数的名称来更轻松地理解其用途。例如，如果您始终对变量使用驼峰命名法，对函数使用帕斯卡命名法，那么一眼就能清楚哪些是变量，哪些是函数。

C++ 代码

#include <iostream>
int main() {
  // Using a consistent naming convention (camelCase for variables) makes it
  // easier to understand the purpose of each variable.
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;
  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.

增强可维护性：一致的命名约定可以帮助您更轻松地在代码中查找特定的变量或函数。例如，假设您始终为存储特定类型数据的变量使用特定的前缀或后缀（例如，字符串使用“str”，数组使用“arr”）。在这种情况下，当您需要进行更改时，会更容易找到该类型的所有变量。

C++ 代码

#include <iostream>
// Using a consistent naming convention (PascalCase for functions) makes it
// easier to locate specific functions in your code.
void PrintGreeting() {
  std::cout << "Hello, world!" << std::endl;
}
int main() {
  PrintGreeting();
  return 0;
}

输出

Hello, world!

减少错误：使用一致的命名约定可以通过更容易地识别名称相似但用途不同的变量或函数来帮助减少代码中的错误。例如，假设您始终为存储特定类型数据的变量使用特定的前缀或后缀（例如，字符串使用“str”，数组使用“arr”）。在这种情况下，更容易发现因在给定上下文中使用了错误类型的变量而导致的错误。

C++ 代码

#include <iostream>
int main() {
  // Using a consistent naming convention (prefixes to indicate variable type)
  // can help reduce errors by making it easier to identify the correct type
  // of variable to use in a given context.
  int numCustomers = 10;
  double avgSaleAmount = 25.50;
  std::string customerName = "John Smith";
  std::cout << "Number of customers: " << numCustomers << std::endl;
  std::cout << "Average sale amount: " << avgSaleAmount << std::endl;
  std::cout << "Customer name: " << customerName << std::endl;
  return 0;
}

输出

Number of customers: 10
Average sale amount: 25.5
Customer name: John Smith

增加协作：一致的命名约定可以使多个人更容易地处理同一个代码库，因为它有助于确保每个人都使用相同的命名约定。这有助于避免混淆并减少合并代码更改时的冲突风险。

C++ 代码

#include <iostream>
// Using a consistent naming convention (PascalCase for functions) can help
// ensure that multiple people working on the same codebase are using the same
// conventions, which can reduce conflicts and confusion when merging code
// changes.
void PrintGreeting() {
  std::cout << "Hello, world!" << std::endl;
}
int main() {
  PrintGreeting();
  return 0;
}

输出

Hello, world!

提升专业性：遵循一致的命名约定可以体现专业精神和对细节的关注，这在与客户合作或在专业环境中工作时尤其重要。使用一致的命名约定还可以使您的代码在视觉上更具吸引力，并且更容易阅读，这在任何情况下都可能是一笔宝贵的财富。

C++ 代码

#include <iostream>
int main() {
  // Using a consistent naming convention (camelCase for variables) can make
  // your code more visually appealing and easier to read, which can be a
  // valuable asset in any situation.
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;

  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.

命名约定的缺点

在 C++ 中使用命名约定存在一些潜在的缺点

额外的工作量：遵循一致的命名约定需要付出额外的努力和纪律，因为您必须记住在每次命名变量或函数时都使用正确的约定。如果您正在与具有不同命名约定的团队合作，或者正在处理需要您遵循与您习惯不同的特定命名约定的项目，这可能特别具有挑战性。

C++ 代码

#include <iostream>
int main() {
  // Adhering to a consistent naming convention (camelCase for variables)
  // requires extra effort and discipline, as you have to remember to use the
  // correct conventions every time you name a variable or function.
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;
  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.

局限性：使用一致的命名约定也可能有限制，因为它可能会限制您可以为变量或函数使用的名称。例如，如果您使用的命名约定要求您为特定类型的变量使用特定的前缀或后缀，则可能无法使用您原本倾向的某些名称。

C++ 代码

#include <iostream>
int main() {
  // Using a consistent naming convention (prefixes to indicate variable type)
  // can be limiting, as it may restrict the names you can use for variables.
  // For example, if you want to use a name like "customer_name" for a string
  // variable, you may not be able to do so if your naming convention requires
  // you to use a specific prefix or suffix (such as "str" or "s").
  std::string strCustomerName = "John Smith";
  std::cout << "Customer name: " << strCustomerName << std::endl;
  return 0;
}

输出

Customer name: John Smith

潜在的冲突：不同的人或团队在命名约定方面可能有不同的偏好，如果每个人没有达成共识，可能会导致冲突。如果您正在处理一个有许多贡献者的大型项目，这尤其成问题。

C++ 代码

#include <iostream>
int main() {
  // Different people or teams may have different preferences when it comes to
  // naming conventions, which can lead to conflicts if everyone is not on the
  // same page.
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;
  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.

缺乏灵活性：根据您正在使用的命名约定，它可能并不总是最适合或最直观的选择。例如，如果您使用要求您对变量使用驼峰命名法的约定，您可能不得不为那些使用下划线或其他分隔符更能自然表达的变量想出不太直观的名称。

C++ 代码

#include <iostream>
int main() {
  // Depending on the naming convention you are using, it may not always be the
  // most appropriate or intuitive choice for every situation. For example, if
  // you are using a convention that requires you to use camelCase for variables,
  // you may have to come up with less intuitive names for variables that would
  // be more naturally expressed using underscores or other separators.
  int num_customers = 10;
  double avg_sale_amount = 25.50;
  std::string customer_name = "John Smith";
 std::cout << "Number of customers: " << num_customers << std::endl;
  std::cout << "Average sale amount: " << avg_sale_amount << std::endl;
  std::cout << "Customer name: " << customer_name << std::endl;
  return 0;
}

输出

Number of customers:

C++、Python、Java 和 C 都是具有变量和函数命名约定的编程语言。以下是这些语言遵循的命名约定之间的一些主要区别：C++：在 C++ 中，变量和函数通常使用驼峰命名法（camelCase）命名，其中第一个单词的首字母除外，每个单词的首字母都大写（例如，“numberOfApples”）。常量变量通常使用全大写（ALL_CAPS）命名，单词之间用下划线分隔（例如，“MAX_CUSTOMERS”）。

示例

#include <iostream>
// camelCase is often used for variable names
int numberOfApples = 5;
int numberOfOranges = 3;
int totalFruit = numberOfApples + numberOfOranges;

// ALL_CAPS is often used for constant variables
const int MAX_CUSTOMERS = 100;
int main() {
  std::cout << "We have " << totalFruit << " pieces of fruit." << std::endl;
  std::cout << "MAX_CUSTOMERS is " << MAX_CUSTOMERS << "." << std::endl;
  return 0;
}

输出

We have 8 pieces of fruit.
MAX_CUSTOMERS is 100.

Python：在 Python 中，变量和函数通常使用蛇形命名法（snake_case）命名，单词之间用下划线分隔（例如，“number_of_apples”）。常量变量通常使用全大写（ALL_CAPS）命名，单词之间用下划线分隔（例如，“MAX_CUSTOMERS”）。

示例

# snake_case is often used for variable names
number_of_apples = 5
number_of_oranges = 3
total_fruit = number_of_apples + number_of_oranges
# ALL_CAPS is often used for constant variables
MAX_CUSTOMERS = 100
print(f"We have {total_fruit} pieces of fruit.")
print(f"MAX_CUSTOMERS is {MAX_CUSTOMERS}.")

输出

We have 8 pieces of fruit.
MAX_CUSTOMERS is 100.

Java：在 Java 中，变量和函数通常使用驼峰命名法（camelCase）命名，其中第一个单词的首字母除外，每个单词的首字母都大写（例如，“numberOfApples”）。常量变量通常使用全大写（ALL_CAPS）命名，单词之间用下划线分隔（例如，“MAX_CUSTOMERS”）。C：在 C 中，变量和函数通常使用蛇形命名法（snake_case）命名，单词之间用下划线分隔（例如，“number_of_apples”）。

常量变量通常使用全大写（ALL_CAPS）命名，单词之间用下划线分隔（例如，“MAX_CUSTOMERS”）。需要注意的是，这些只是一般的约定，在任何这些语言中都可以使用不同的命名约定。但是，通常最好遵守您所从事的语言或社区所遵循的约定，因为它使他人更容易阅读和理解您的代码。

示例

public class Main {
  // camelCase is often used for variable names
  int numberOfApples = 5;
  int numberOfOranges = 3;
  int totalFruit = numberOfApples + numberOfOranges;
// ALL_CAPS is often used for constant variables
  static final int MAX_CUSTOMERS = 100;
  public static void main(String[] args) {
    System.out.println("We have " + totalFruit + " pieces of fruit.");
    System.out.println("MAX_CUSTOMERS is " + MAX_CUSTOMERS + ".");
  }
}

输出

We have 8 pieces of fruit.
MAX_CUSTOMERS is 100.

下一主题动态数组

C++ 命名约定

C++ 命名约定指南

命名约定的优点

命名约定的缺点

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

C++ 教程

C++ 控制语句

C++ 函数

C++ 数组

C++ 类和对象

C++ 构造函数

C++ 继承

C++ 多态

C++ 抽象

C++ 命名空间

C++ 模板

C++ 字符串

C++ 指针

信号处理

C++ 异常

C++ 文件与流

C++ STL 教程

面试题

选择题

C++ 程序

C++ STL Stack

C++ STL Bitset

C++ STL Deque

C++ STL List

C++ STL Map

C++ STL Math

C++ STL priority_queue

C++ STL Queue

C++ STL Multiset

C++ STL Multimap

C++ STL Set

C++ STD Strings

C++ STL Vector

C++ 操纵符

C++ STL Algorithms

C++ Algorithm

C++ Iterators

C++ 杂项

C++ 命名约定

C++ 命名约定指南

命名约定的优点

命名约定的缺点

相关帖子

C++ 程序实现插值搜索算法

在 C++ 中生成数组排列的不同方法

C++ Cerr

C++ 变参模板

Boost C++ | C++ 编程中 Boost 的历史、目的、优点

C/C++ vswprintf() 函数

C++ 冒泡排序

C++ 中范围内所有子数组按位与和的查询

C++ 标记

C++ 无序集合

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器