[笔记]c++Windows平台代码规范（上）

前言

微软风格=匈牙利风格=函数大驼峰+变量小驼峰+标明类型 例如InitTool(), mIsOpen, bOpen等

谷歌偏c风格 下划线很多 谷歌风格linux使用比较多,例如init_tool(),m_is_open, is_open等

1.文件结构

1.1 版权和版本的声明

文件头 全使用英文 减少中文编码乱码问题

/****************************************************************
* Copyright (c) 2021 by XXX Company
* 
* file description：Export To Be DLL Implement
* version：    1.0.0
* author：     Shiver
* time：       2021 / 05 / 31
****************************************************************/

1.2 导出头文件命名 XXXAPI.h

项目名+API+.h 作为导出dll 的对应头文件 统一格式方便查找

1.3 常见项目结构

-ProjectName
--src
--include
--lib
--bin
--res

src 目录 存源码包括（*.cpp、*.h,*.cc,*.hpp)

include 目录 存引入第三方库的 *.h文件

lib 目录 存引入第三方库的*.lib、*.a 、*.so （静态库和动态链接库)

bin 目录 存引入第三方库的*.dll (动态库）

res 目录 存资源文件 例如*.jpg、*.icon

1.4 头文件 防止重复引入

#ifndef XXX_H
#def XXX_H
// 主要内容
#endif 

注：尽量不要使用#pragram once,不利于跨平台 貌似只有windows有这个宏

1.5 导出接口命名

格式：

返回类型+“ ”+公司简称+“_”+模块简称+“_"+函数名(动+宾结构)+“（”+形参列表+“）”；

例如：

int ByteDance_Decoder_CreateDecoder(int a, int b);

当然导出的接口 自然有一些导出宏之类的 WINAPI 、extern "C"等 记得定义为宏 统一添加

1.6 类和虚类命名

类(Class)以C开头，例如CFactory

虚类（接口Interface）以I开头，例如IFactory

2.参数命名

2.1 局部变量

int: nXXX iXXX

指针:pXXX

char数组:szXXX

wchar_t数组:wszXXX

2.2 静态变量

s:static 静态变量

int:s_iXXX

2.3 全局变量

g:glogbal 全局变量

int: g_iXXX;

2.4 成员变量

m:member 成员

int:m_iXXX

2.5 常见变量命名

表一 基本类型及前缀规范

表2 变量属性公共前缀规则

2.6 形参和实参命名

形参 最好能标识方向以及参数安全，避免被修改

输入形参：void test(int nInParam);

void test(const type *nInParam); //有时传只能是避免结构体拷贝过于消耗性能，所以此时要注意参数安全，避免函数调用完后参数被修改。

输出形参：void test(int &nOutParam);

3.函数命名

3.1 大驼峰命名

void ThisIsFunction();

3.2 动词＋名词 结构

全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。

例如:
InitModule()
SetHeight()
StartAction()
StopAction()
DestoryModule()

类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。

class Shoes {
   void Wear(); // wear the shoes
   void TakeOff(); // take off the shoes
   void Drop(); // drop the shoes
}

3.3 单个对象用 is has, 多个对象的集合用复数形态

比如

deleteFile，moveFiles，getChildren，单数复数表达的含义是不同的，file表示操作单个文件，files表示可以接受文件集合，children表示子节点不止一个。

3.4 用时态语态可以传达更多信息，增强可读性。

对于正在发生的事情用进行时，doing;

对于一个做完的事情用过去式 did done。比如当状态发生变化的时候，

对于正在改变但是还没彻底变完，xxxChanging，

对于已经变了 xxxChanged 表示真的变了。