最实用的C++编码规范

目录

命名约定：

注释风格:

代码格式:

智能指针的使用:

异常处理:

示例代码:

总结:

---

在软件开发领域，编码规范是确保代码质量、提高团队协作效率和保持代码可读性的重要基石。Google作为全球顶尖的科技公司，其编码规范一直备受推崇。

本文是对Google编码规范的常用到的知识总结，感兴趣的可以去官网看全部的：官网链接。

同时google官网也有相应的代码规范工具可以使用，链接如下：

https://github.com/cpplint/cpplint.git

以下是一些常见的C++ Google编码规范，以及相应的示例代码：

命名约定：

class MyClass {  
public:  
    MyClass();  
    void MyFunction(int myParam);  
    static const int MY_CONSTANT = 42;  
};

1. 类名、接口名和枚举名使用大写字母开头的驼峰命名法（CamelCase）。

2. 变量名、函数名和参数名使用小写字母开头的驼峰命名法。

3. 常量名使用全大写字母和下划线分隔的命名方式。

注释风格:

// 计算两个数的和  
int Sum(int a, int b) {  
    return a + b; // 返回a和b的和  
}

1. 使用//进行单行注释，使用/* */进行多行注释。

2. 释应简洁明了，解释代码的意图和逻辑，而不是简单地复述代码本身。

代码格式:

void MyFunction() {  
    if (condition) {  
        // 处理条件  
        DoSomething();  
    } else {  
        // 处理其他情况  
        DoSomethingElse();  
    }  
}

1. 用4个空格进行缩进，不使用制表符（Tab）。

2. 每行代码不超过80个字符，超过时自动换行。

3. 函数体、类体和循环体等代码块使用大括号进行包围，即使块内只有一条语句也不例外。

智能指针的使用:

std::unique_ptr<MyClass> ptr = std::make_unique<MyClass>();  
// 使用ptr进行操作，无需手动释放内存

推荐使用智能指针（如std::unique_ptr和std::shared_ptr）来管理动态内存，以避免内存泄漏和悬挂指针等问题。

异常处理:

void MyFunction() {  
    try {  
        // 可能抛出异常的代码  
        RiskyOperation();  
    } catch (const std::exception& e) {  
        // 处理异常  
        std::cerr << "Exception caught: " << e.what() << std::endl;  
    }  
}

谨慎使用异常处理，仅在需要时抛出和捕获异常，避免过度使用导致代码难以理解和维护。

示例代码:

以下是一个完整的示例代码，展示了C++ Google编码规范在实际项目中的应用：

#include <iostream>  
#include <memory>  
  
// 定义一个类  
class MyClass {  
public:  
    MyClass() {  
        std::cout << "MyClass constructor called" << std::endl;  
    }  
    ~MyClass() {  
        std::cout << "MyClass destructor called" << std::endl;  
    }  
      
    void DoSomething() const {  
        std::cout << "Doing something in MyClass" << std::endl;  
    }  
      
    static const int MY_CONSTANT = 42;  
};  
  
// 使用智能指针管理动态内存  
void UseSmartPointer() {  
    std::unique_ptr<MyClass> ptr = std::make_unique<MyClass>();  
    ptr->DoSomething();  
    // 无需手动释放内存，ptr离开作用域时会自动销毁  
}  
  
// 谨慎使用异常处理  
void RiskyOperation() {  
    // 模拟可能抛出异常的代码  
    throw std::runtime_error("An error occurred");  
}  
  
int main() {  
    try {  
        UseSmartPointer();  
        RiskyOperation(); // 这行代码会抛出异常  
    } catch (const std::exception& e) {  
        std::cerr << "Caught an exception: " << e.what() << std::endl;  
    }  
      
    return 0;  
}

总结:

Google编码规范是一套详细而严格的编码标准，通过遵循这些规范，可以显著提高代码的质量、可读性和可维护性。