编程规范参考

匈牙利命名法

开头字母用变量类型的缩写，其余部分用变量的英文或英文的缩写，要求单词第一个字母大写。
ex:
int iMyAge； i是int类型的缩写；
char cMyName[10]； c是char类型的缩写；
float fManHeight；f是float类型的缩写；

前缀名称	对应关系
a	array
b	boolean
by	byte
c	char
h	Handle
p	pointer
st	struct
e	enum

驼峰式命名法

第一个单词首字母小写，后面其他单词首字母大写
比如：
int myAge；
char myName[10]；
float manHeight；

头文件注释和函数注释模板

头文件注释

/*******************************************************************************
  * Copyright(C),2022,OpenSource Project
  * @file Name
  * @author  
  * @version V1.0.0
  * @date
  * @brief
  * @History
*******************************************************************************

函数注释

/****************************************************
  * @functionName
  * @brief
  * @param
  * @retval
****************************************************/

常用缩写

缩写	说明
tmp	temp
flg	flag
staticstic	stat
inc/dec	increament，decrement
msg	message
staticstic	stat
len	length
id	NA
res/ret	result，returnvalue

结构体，枚举类型定义格式

typedef struct MI_AAA_StructureName_s
{
    int aaa;
    int bbb;
} MI_AAA_StructureName_t;

typedef struct MI_OSD_InitRegion_s
{
    int aaa;
    int bbb;
} MI_OSD_InitRegion_t;

typedef enum
{
    E_ MI_OSD_ENABLE,
    E_ MI_OSD_DISABLE
} MI_OSD_InitRegion_e;

一些有意义的名词缩写
add /remove
begin / end
create / destroy
insert /delete
first /last
get /release
increment /decrement
put/get
lock /unlock
open /close
min /max
old / new
start/ stop
next / previous
source / destination
cut / paste
send / receive
show / hide

create/destroy
begin/end
start/stop
open/close
add/remove
insert /delete

lock/unlock
min/max
show/hide
increment /decrement
next/previous
send/receive
set/get
src/dst