谷歌代码规范的中文版
https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/
类名和文件名同名, 例子如下:
类 名:WorkThreadPool
文件名:WorkThreadPool.cpp
函数名例子:
void Logger::setWriter
结构体struct :
struct avpacket_queue_t
{
std::queue<avpacket_t*>::size_type maxsize;
std::queue<avpacket_t*> q;
ThreadLocker locker;
ThreadEvent event;
};
private变量参考:
private:
recursive_mutex _mtxListener; //私有mutex 加头缀_mtx
MapType _mapListener; //私有map 加头缀_mapunsigned char *_pucPcmBuf = nullptr;
unsigned int _uiPcmLen = 0;
void *_hEncoder = nullptr;
unsigned long _ulMaxInputBytes = 0;
常用的变量命名
1.类函数里面变量,全小写
2.前面不用加前缀s32 u32等,直接一个小变量
int ret; //返回值
auto err = get_uv_error(true);//错误变量err
类指针变量的命名
class Logger : {
public:
typedef std::shared_ptr<Logger> Ptr; //在类里定义指针
... ...
}别处使用的时候,可以这么用
Logger::Ptr _logger;
namespace
在文件cpp开头部分先声明namespace,后面变量调用简洁些
using namespce std;尽量不要(或者强硬一点,不许)在头文件中使用。
原因: 不让这么用,主要原因就是防止名字重复(即自定义变量名和std中名字重复),因为头文件会被很多地方使用,不知道这个using能覆盖多大范围。
using namespace std;