Windows客户端C/C++编程规范“建议”——文件

7 文件

7.1 正确使用#include

等级：【推荐】

说明：#include <>和#include “”导致编译器在搜索文件时，搜索的路径顺序不同。所以需要正确使用#include，以避免包含错了头文件。

语法形式 操作
带引号的形式 预处理器按以下顺序搜索包含文件：

  1. 在包含 #include 语句的文件所在的同一目录中。
  2. 在当前打开的包含文件的目录中，采用与打开它们的顺序相反的顺序。 搜索从父包含文件的目录中开始进行，然后继续向上到任何祖父包含文件的目录。
  3. 跟随每个 /I 编译器选项指定的路径。
  4. 跟随 INCLUDE 环境变量指定的路径。
尖括号形式 预处理器按以下顺序搜索包含文件：

  1. 跟随每个 /I 编译器选项指定的路径。
  2. 通过命令行进行编译时，跟随 INCLUDE 环境变量指定的路径。

7.2 重复引用头文件需控制

等级：【必须】

说明：不可避免的头文件引用存在交叉的场景，所以在定义头文件时，使用域控制等方法控制重复引用问题。

例子：

#pragma once
// 头文件实际内容

或

#ifndef PATH_XXX_HEADER_H
#define PATH_XXX_HEADER_H
// 头文件实际内容
#endif

对于使用#define方式确保头文件不会被重复包含，需要考虑定义的宏名称的唯一性。推荐使用“文件路径”+“_”+“文件名”的方式。比如trunk/core/src/filecheck.h的宏为TRUNK_CORE_SRC_FILECHECK_H。

7.3 头文件中不要定义全局变量

等级：【要求】

说明：减少代码膨胀。

7.4 头文件引用顺序

等级：【推荐】

说明：按如下顺序布局头文件：

  1. C(标准) 库
  2. C++(标准)库
  3. Boost库
  4. 其他库
  5. 自己Project头文件

7.5 减少头文件依赖

等级：【推荐】

说明：通过前置声明的方法替代include文件头的方式，可以减少头文件依赖。这对编译速度有提升。

（转载请指明出于breaksoftware的csdn博客）

Windows客户端C/C++编程规范“建议”——文件,布布扣,bubuko.com

时间： 2024-11-14 00:18:01

Windows客户端C/C++编程规范“建议”——文件的相关文章

Windows客户端C/C++编程规范“建议”——前言

前言 工作中接触了很多编程规范.其中最有意思的是,公司最近发布了一版C/C++编程规范,然后我看到该规范的最后一段时,有这么一句:"该规范不适用于Windows平台开发".看来这份规范是由做其他平台开发的同学制定的.那么做Windows开发的人都去哪儿了?后来由于工作需要,项目组需要我制定一份编程规范.这也是我这系列博客的由来.(转载请指明出于breaksoftware的csdn博客) 说到"规范"",可能没多少人喜欢这样的东西.相信很多工程师和我一样,都

Windows客户端C/C++编程规范“建议”——函数

1 函数 1.1 代码行数控制在80行及以内 等级:[要求] 说明:每个函数的代码行数控制应该控制在80行以内.如果超过这个限制函数内部逻辑一般可以拆分.如果试图超过这个标准,请列出理由.但理由不包含如下: 无法拆分. 流程内部逻辑复杂,无需拆分,即使拆分了,拆分的函数也不会被其他地方用到.(解释:拆分可以减少代码行数,提炼后的函数可以方便读者快速理解函数逻辑并定位问题.) 1.2 代码列数控制在100字符及以内 等级:[要求] 说明:每行代码不可以超过100字符.如果超过这个字符数,代码的美观

Windows客户端C/C++编程规范“建议”——指针

2 指针 2.1 尽量使用智能指针 等级:[推荐] 说明:正确使用智能指针可以省去指针管理的工作. 2.2 类成员变量指针释放后一定要置空 等级:[必须] 说明:如果类成员变量指针在释放后没有置空,将出现如下问题: a) 无法判断指针是否已经是野指针 b) Dump分析很难发现是野指针函数调用导致崩溃 2.3 正确使用delete和delete[] 等级:[必须] 说明:delete[]用于释放动态分配的数组,而delete用于释放对象.两者不可以混用. 2.4 使用指针前要判空 等级:[必须]

Windows客户端C/C++编程规范“建议”——函数调用

3 函数调用 3.1 谨慎使用递归方法 等级:[推荐] 说明:递归方式控制不当,可能会导致栈空间不够而崩溃.一般的递归都可以使用循环代替. 3.2 不要使用using namespace 等级:[必须] 说明:这是曾经教科书上的一种写法,但是该方法存在严重的缺陷.因为如果多个不同的namespace里定义了相同名字的变量或者函数.将导致无法预知和理解编译器最终使用的是哪个命名空间中的数据. 例子: //file1 namespace Space1{ int g_Private = 0; }; /

Windows客户端C/C++编程规范“建议”——表达式和运算

4 表达式和运算 4.1 比较操作中将常量设置为左值 等级:[推荐] 说明:编写代码时,如果将常量设置为右值.可能因马虎将"=="写成"="导致逻辑错误.这种场景下,编译器是不会报错的,代码检查也比较容易被忽视. 例子: std::string::size_type index = str.find("a"); if ( index = std::string::npos){ } 上例中写法可以执行,但是逻辑是错的.如下编写,可以借助编译器检查出

Windows客户端C/C++编程规范“建议”——结构

5 结构 5.1 不要使用goto 等级:[必须] 说明:在大型项目中,goto的滥用会导致灾难性后果.因为我们程序中一般不存在从一个函数体内部跳转到另一个函数体内部的场景,所以我们可以将跳转控制在函数内部,从而避免灾难. 例子: do { if ( False ) { break;// 相当于goto } } while (0); 5.2 不要利用异常机制实现流程的跳转 等级:[必须] 说明:该方法比较常见于防逆向等方面,但是我们普通编程方式应该严禁使用.否则将增加代码阅读的难度. (转载请指

Windows客户端C/C++编程规范“建议”——宏

6 宏 6.1 减少宏的使用 等级:[建议] 说明:宏的使用,将使得调试变得麻烦.所以在设计和使用宏的时候,请确保宏的逻辑是阅读者不会去关心细节的行为. 6.2 宏定义中字母需大写 等级:[必须] 说明:为了醒目表示它是一个宏,而不是一个函数. 6.3 使用const变量代替宏定义值 等级:[建议] 说明:在一个函数体内部使用的常量,最好使用const变量替代,而不是使用宏. 6.4 使用枚举代替一系列有关联的宏 等级:[建议] 说明:比如一个函数返回一系列表示状态的宏,则应该使用枚举类型替代.

Windows客户端C/C++编程规范“建议”——风格

9 风格 9.1 优先使用匈牙利命名法 等级:[推荐] 说明:该方法由微软总设计师设计.Windows上编程最好遵从该标准.详细介绍见:http://zh.wikipedia.org/wiki/%E5%8C%88%E7%89%99%E5%88%A9%E5%91%BD%E5%90%8D%E6%B3%95 9.2 变量名结合使用匈牙利命名法和驼峰命名法 等级:[推荐] 说明:比如 int nMaxCount = 1;中变量前缀n表示int型变量,MaxCount是表意,其就是使用驼峰命名法(首字母大

Windows客户端C/C++编程规范“建议”——变量和常量

8 变量和常量 8.1 尽量不要使用全局变量 等级:[要求] 说明:全局变量的滥用和goto的滥用一样,都是一种灾难.它将使得逻辑变得难以调试和控制. 8.2 不涉及外部使用的全局变量需要使用static关键字修饰 等级:[要求] 说明:这样可以避免冲突. 8.3 变量需初始化后才能使用 等级:[必须] 说明:变量最好在定义时初始化.如果定义时无法初始化,那就应该在定义后立即初始化. 以下我们来分析下变量未初始化而被使用的场景: 在debug环境下,我们声明一个变量,编译器会使用0xCC填充变量