变量
变量命名 里面只能是名词,不能有动词
- 宏:全部大写,如:FRAME_SIZE
- 变量:驼峰命名规则,首个单词小写,如:myFrameSize
- 全局变量:在变量前后添加字母 G,如:myFrameSizeG
函数
尽量利用动词表达函数功能
- 利用下划线连接各单词,如 av_audio_fifo_alloc()
类
- 类名 采用驼峰命名规则,但首单词首字母大写,如:MyFrame
- 类函数 命名规则 与 函数 类似
注释
声明注释 /**/
- 变量/函数/类 声明的注释采用如下形式
/**
* 注释本体
*/
int myFrameSize;
- 如果是函数,尽量在注释本体说明 函数功能、输入、输出含义,如:
/**
* Allocate an AVAudioFifo.
*
* @param sample_fmt sample format
* @param channels number of channels
* @param nb_samples initial allocation size, in samples
* @return newly allocated AVAudioFifo, or NULL on error
*/
AVAudioFifo *av_audio_fifo_alloc(enum AVSampleFormat sample_fmt, int channels,
int nb_samples);