使用头文件保护（#ifndef）或静态修饰符（static）来避免代码重复定义具体代码

时间: 2023-06-07 22:08:12 浏览: 152

Google开源风格指南学习笔记-c++代码规范

### Google开源风格指南学习笔记——C++代码规范详解 #### 避免多重包含与使用前置声明在C++开发中，避免多重包含是至关重要的，因为它可以减少编译时间并降低代码之间的依赖关系。当一个头文件被多次包含时，可能会导致编译错误或者资源浪费。使用`#pragma once`或者条件编译指令如`#ifndef`/`#define`/`#endif`可以帮助解决这个问题。此外，使用前置声明而不是完整的头文件包含是一种减少依赖和加快编译速度的有效方式。例如，如果一个类只需要知道另一个类的存在而不需要访问其内部细节，那么只需进行前置声明即可。 #### 内联函数的使用内联函数可以在调用处直接展开，从而提高代码的执行效率，但过多的内联会导致目标代码增大，进而可能影响到程序的加载时间和内存占用。通常，当函数体小于10行时，内联是推荐的，但这并非绝对规则，开发者应根据具体情况进行判断。 #### 函数参数的顺序定义函数时，遵循“先输入后输出”的原则，即输入参数先于输出参数声明，有助于提高代码的可读性和理解性。这种做法使得函数的调用者能够更直观地识别出哪些参数用于提供数据，哪些参数用于接收结果。 #### 包含文件的路径顺序按照特定的顺序包含文件，即“本文件及本项目头文件 -> C系统文件 -> C++系统文件 -> 其他库的头文件”，可以减少命名冲突，确保代码的稳定性和可维护性。 #### 匿名名字空间的利用匿名名字空间可以避免全局命名空间中的命名冲突，同时防止`using`关键字过度使用导致的命名污染。这有助于保持代码的清晰度和模块化。 #### 嵌套类的使用原则嵌套类应该遵循局部使用原则，意味着它们应该在定义它们的类的内部使用，而不应该在其他头文件中前置声明。尽量避免使用`public`访问修饰符，以限制其可见性，从而增强封装性。 #### 全局函数和变量的限制尽量减少全局函数和全局变量的使用，因为它们可能会引起不可预料的行为和副作用，尤其是在多线程环境中。对于多线程中的全局变量，尤其是类类型或STL容器，应特别小心，因为它们可能导致数据竞争和不一致的状态。 #### 构造函数内的异常处理构造函数中应避免使用复杂的逻辑和可能抛出异常的操作，以免对象处于不确定状态。如果构造失败，对象应当保证能够安全地被销毁，不会留下任何副作用。 #### 拷贝和赋值构造函数的禁用技巧通过在私有部分声明拷贝构造函数和赋值操作符而不提供实现，可以有效地防止这些操作被调用，从而保护对象的完整性。这种方法通常被称为“私有化并忘记”（Private and Forget），是C++中一种常见的防止拷贝和赋值的设计模式。 #### struct与class的使用场景当一个类型主要用作数据集合时，使用`struct`可以强调这一点。然而，在大多数情况下，使用`class`更为常见，它提供了更强的封装性和安全性。 #### 子类重载虚函数的声明即使在子类中重载了父类的虚函数，也应显式地使用`virtual`关键字。这样做不仅增强了代码的可读性，还提醒了后续的开发者注意该函数的虚特性，从而避免未来可能出现的错误。 #### 接口类的设计接口类应以`Interface`作为后缀，除了提供带实现的虚析构函数和静态成员函数外，其余均为纯虚函数，以确保类无法实例化。这样设计有利于构建面向接口的编程模式，提高代码的灵活性和扩展性。 #### 操作符重载的限制为了降低代码的复杂度和提高可读性，应尽量避免重载操作符。如果确实需要重载，应确保其行为符合预期，并且易于理解和使用。 #### 函数的简洁性与单一职责函数应保持简洁、紧凑，并具有单一的功能。过长或功能复杂的函数难以维护和理解，应该拆分为更小、更专注的单元。 #### 智能指针的使用与局限性虽然智能指针如`std::shared_ptr`和`std::unique_ptr`提供了内存管理的便利性，但在某些情况下，过度依赖智能指针可能导致不必要的开销。因此，应谨慎使用，并尽量将其作用范围限制在局部。 #### cpplint.py工具的应用 cpplint.py是一个由Google开发的代码风格检查工具，用于检测和修正不符合Google C++风格指南的代码。定期使用此工具可以显著提高代码质量和一致性。 #### 引用传参与const的一致性在使用引用传参时，务必加上`const`限定符，以确保不会无意中修改传递的参数。这样不仅可以提高代码的安全性，还能清晰地表达函数的行为意图。 #### 函数重载的约束函数重载应仅在功能相似但参数类型或数量不同的情况下使用。同时，函数名应尽量包含参数的信息，以便于区分不同重载版本的功能。 #### 缺省函数参数的禁止为了避免潜在的二义性和混淆，不应使用缺省函数参数。这样做可以确保函数调用的清晰性和可预测性。 #### 变长数组与alloca()的禁止变长数组和`alloca()`函数可能导致堆栈溢出和其他未定义行为，因此在C++中应避免使用。替代方案是使用动态分配的数组或容器类型。 #### 友元的合理使用尽管友元可以提供对类的私有成员的访问，但应谨慎使用，以防止封装性的破坏。只有在确实需要外部访问的情况下，才考虑使用友元类或友元函数。 #### C++异常的使用与避免 C++异常机制可以提供错误处理的灵活性，但在某些性能敏感的场景下，应避免使用异常，因为它们可能引入额外的开销。开发者应根据具体情况权衡是否使用异常处理。 #### RTTI的禁止与替代方案运行时类型识别（RTTI）在某些情况下可能造成性能损失，并且增加了代码的复杂度。如果可能，应设计避免使用RTTI，比如通过策略模式或工厂模式来实现多态性。 #### 使用C++标准转换 C++提供了多种类型转换机制，如`static_cast`、`dynamic_cast`、`const_cast`和`reinterpret_cast`，它们比C风格的强制类型转换更安全、更明确。 #### 替代printf和scanf的流操作使用C++的流操作代替传统的`printf`和`scanf`，可以提供更好的类型安全性和代码可读性。例如，`std::cout`和`std::cin`分别用于输出和输入，能够自动处理不同类型的数据转换。 #### ++i与i++的选择在不影响程序逻辑的情况下，`++i`（前缀递增）通常比`i++`（后缀递增）效率更高，因为它不涉及临时变量的创建。 #### const的广泛运用 `const`关键字的广泛使用可以提高代码的安全性和效率，因为它限制了变量或对象的修改，同时也帮助编译器进行优化。 #### Boost库的选择仅使用那些经过社区验证和广泛认可的Boost库，以确保代码的质量和兼容性。 #### 命名规则与风格命名规则应清晰、一致，避免使用匈牙利命名法，转而采用更具描述性的命名方式。名称可以全部大写、全部小写加下划线分隔，或者驼峰式命名法。 #### 注释与TODO的使用注释应简洁明了，旨在解释“为什么”而非“怎么做”。使用`TODO`注释标记待办事项或需要改进的地方，有助于跟踪代码的改进和维护。 #### 代码格式与编码规范保持代码格式一致，每行字符数不超过80，避免使用非ASCII字符，除非使用UTF-8编码。使用空格而非制表符进行缩进，确保代码在各种编辑器中都能正确显示。 #### 代码布局与空白的使用合理的空白使用可以增强代码的可读性，如在括号内外留适当空格，以及在代码块之间添加适当的垂直空白。然而，过多的空白可能使代码显得分散，应适度使用。通过遵循这些详细的C++代码规范，开发者可以编写出更加高效、可靠且易于维护的代码，同时也有助于团队协作和代码共享。Google的C++风格指南不仅是技术上的指导，更是对软件工程最佳实践的深入探索。

include guard）是什么？头文件保护是一种技术，用于防止头文件被重复包含。如果一个头文件被重复包含，就会导致编译错误和不可预知的行为。为了避免这种情况发生，可以在头文件中添加 include guard 来保护它。在头文件的开始处添加 ifndef、define 和 endif 指令，确保头文件只被编译一次，即使它被多个源文件包含。

阅读全文

使用头文件保护（#ifndef）或静态修饰符（static）来避免代码重复定义具体代码

相关推荐

嵌入式软件面试题整理.pdf

嵌入式C语言面试题汇总

则在头文件中使用#ifndef和#define宏来避免重复定义。怎么用，举个例子

头文件中#ifndef/#define

在C/C++项目中，如何利用头文件保护宏（#ifndef, #define, #endif）来防止全局变量的重复定义，从而避免编译和链接错误？

在C/C++项目开发中，如何通过头文件保护宏（#ifndef, #define, #endif）来防止头文件中全局变量的重复定义问题，从而避免编译和链接时产生的错误？

C头文件声明时 #ifndef __与#ifndef_的区别

如何在C/C++中使用头文件保护避免全局变量重复定义导致的编译和链接错误？

如何使用预编译指令ifndef避免头文件重复包含

keil5头文件#ifndef报错

#ifndef长代码应用举例

c++头文件中的#ifndef和define以及endif

#ifndef后面跟什么代码

预处理指令：#ifndef、#define、#endif，为什么能用于防止头文件的重复包含

使用下面结构，还是会报重复定义 #ifndef __xxx__ #define __xxx__ #endif

#pragma once和#ifndef可以同时用在一个头文件中吗

c语言 在头文件定义一个结构体，如何在多个源文件中使用 代码

在实际项目中如何正确使用ifndef和define来组织代码？

在头文件中添加头文件保护宏，以避免重复包含同一个头文件。

最新推荐

浅谈#ifndef,#define,#endif的作用和用法

C/C++语言宏定义使用实例详解

嵌入式系统C代码走查检查单(编程必看).doc

C++获取特定进程CPU使用率的实现代码

win10环境下vscode Linux C++开发代码自动提示配置(基于WSL)

黑板风格计算机毕业答辩PPT模板下载

管理建模和仿真的文件

提升点阵式液晶显示屏效率技术

在SoC芯片的射频测试中，ATE设备通常如何执行系统级测试以保证芯片量产的质量和性能一致？

CodeSandbox实现ListView快速创建指南

使用下面结构，还是会报重复定义 #ifndef xxx #define xxx #endif

c语言在头文件定义一个结构体，如何在多个源文件中使用代码