C++产品开发讲座-(一)编程规范

C++产品开发讲座-(一)编程规范

1. 编程风格

文件夹文件名：⼩写+下划线： demo_data_type.h
枚举类名：
enum class EnumDataType
{
   
 EnumDataTypeA,
 EnumDataTypeB
};
class,struct名：单词首字母大写
class DemoData
{
   
};
函数名：首字母小写，后面单词首字母大写
void procData(uint32_t index_pipeline);
变量名：全小写，单词之间加下划线
uint32_t num_buffer;//变量

2.注释

注释是法外之地
最好代码⾃注释（能通过代码变量命名、代码风格直接体现出编程逻辑最好）

3. 命名

（1）最大对其原则

同一类型，同一属性的变量、函数、枚举等，名称最好都按照相同的属性、类型对齐。

strcut School
{
   
 uint32_t index_grade;
 uint32_t index_class;
 uint32_t index_student;
 uint32_t index_teacher;
};
//index_开头

（2）常用命名前缀，后缀

// 指针
sp_ std::shared_ptr<DemoData> sp_xxx
p_ float* p_xxx
// 函数
procXXX
genXXX
// stl容器
vec_ std::vector<DemoData> vec_demo_data;
arr_ std::array<DemoData, N> arr_xxx
lut_ // look up table
map_ // tsd::map/std::unordered_map
// 其他常⽤
flag_
thread_ //thread
temp_ // 临时
param_ // parameter配置
struct/class ParamXXX //配置参数
cnt_ // counter
num_ // number num_buffer
len_ // length len_vec_data
index_ //index/id
name_ // 名称
msg_ // message
_info // information
val_xxx // value_xxx val_signal
type_xxx // type
// ui控件名
txt_ // textbox, txt_username
lb_ // label
dlg_ // dialog
win_ // windows

4. 编程要求

4.1 凡是有可能失败的函数均返回值为bool、具有资源申请相关的class具有返回值为bool的init

bool procPanMeasGeo(const cv::Mat& img);

原则上，构造函数不做任何可能失败的事情，可能失败的事情交由init函数

class DemoData
{
   
	public:
	 DemoData()
	 {
   
	 	p_data = new float[..