养成一个良好的编码习惯,对自己很有帮助。
一、C++编码规范(Google)
我的总结:
文件命名:小写单词+下划线/短线
my_dll.h
变量命名:小写单词+下划线
int num_errors;
类型命名(类,结构体,类型定义):大写开头单词,不包含下划线
class UrlTable
函数命名:大写开头单词,不包含下划线
DeleteMsg();
内联函数:小写单词+下划线
void set_num_entries(int num_entries)
命名空间: 小写单词+下划线 基于项目名称和目录结构
google_awesome_project
枚举名称:大写开头单词,不包含下划线
枚举值: 大写单词+下划线
enum UrlTableErrors {
OK = 0,
ERROR_OUT_OF_MEMORY,
ERROR_MALFORMED_INPUT,
};
宏命名:大写单词+下划线
#define MAX 10
- 总体规则:不要随意缩写,如果说 ChangeLocalValue 写作 ChgLocVal 还有情可
原的话,把 ModifyPlayerName 写作 MdfPlyNm 就太过分了,除函数名可适当为动
词外,其他命名尽量使用清晰易懂的名词; - 宏、枚举等使用全部大写+下划线;
- 变量(含类、结构体成员变量)、文件、命名空间、存取函数等使用全部小写+下划线 ,
类成员变量以下划线结尾,全局变量以 g_开头; - 普通函数、类型(含类与结构体、枚举类型)、常量等使用大小写混合,不含下划线;
例子:
/*!
* Copyright (C) 2021 爱做尼啊
* 版权所有。
* 代码仅用于测试
\file: main.cpp
\brief 演示用文件
\author wqj
\Date 2021/5
*/
#define MOD 1
#include <iostream>
enum MyEnum
{
ONE = 1,
TWO = 2,
THREE
};
namespace google_mydemo
{
class UseCard
{
public:
void ReadCard()
{
int string_num = ONE;
printf("num:%d \n", string_num);
}
};
}
int main()
{
if (MOD == 1)
{
google_mydemo::UseCard use_card_obj;
use_card_obj.ReadCard();
}
system("pause");
return 0;
}
C++谷歌编码规范中文文档链接:
C++谷歌编码规范