Bootstrap

C程序代码规范

1、头文件(.h)的组织方式(从上到下)

  • 头文件说明         //注释
  • 防止重复包含宏定义//#ifndef __CONFIG_H__ #deine __CONFIG_H__ #endif
  • 调试开关
  • 头文件引用       //#include“config.h”
  • 宏定义           //#define OK 0
  • 结构定义         //struct
  • 常量声明         //int a;
  •  函数原型声明
  • inline/static 函数实现

2、源文件(.c)的组织方式(从上到下)

  • 源文件说明 //注释
  • 调试开关  
  • 头文件引用   //#include“config.h”
  • 宏定义       //#define OK 0
  • 结构定义     //struct
  • 常量定义     //int a;
  • 函数原型声明
  • 全局变量声明
  • 静态变量定义
  • 函数实现

3、C语言程序命名规范

  • 全局变量: gCardNumber   或者g_card_number
  • 静态变量: sCardNumber   或者s_card_number
  • 局部变量: cardNumber    或者card_number
  • 结构体:    cardNumber_t    或者card_number_t
  • 枚举:        cardNumbet_e    或者card_number_e
  • 宏定义:    CARD_NUMBER    
  • 循环变量名: i; j; k;  index    驼峰命名(最好)
  • 状态变量命名: flag;         驼峰命名(最好)
  • 布尔变量命名:  done、error、found、success/ok
  • 函数名: getCardNumber() 或者get_card_number()

4、常用缩写

  • argument 可缩写为 arg
  • buffer 可缩写为 buf
  • clock 可缩写为 clk
  • command 可缩写为 cmd
  • compare 可缩写为 cmp
  • configuration 可缩写为 cfg
  • device 可缩写为 dev
  • error 可缩写为 err
  • hexadecimal 可缩写为 hex
  • increment 可缩写为 inc
  • initialize 可缩写为 init
  • maximum 可缩写为 max
  • message 可缩写为 msg
  • minimum 可缩写为 min
  • parameter 可缩写为 para
  • previous 可缩写为 prev
  • register 可缩写为 reg
  • semaphore 可缩写为 sem
  • statistic 可缩写为 stat
  • synchronize 可缩写为 sync
  • temp 可缩写为 tmp

5、数据类型定义

  • typedef unsigned char uint8_t;
  • typedef char int8_t;
  • typedef unsigned short uint16_t;
  • typedef short int16_t;
  • typedef unsigned int uint32_t;
  • typedef int int32_t;
  • typedef unsigned long long uint64_t;
  • typedef long long int64_t;
  • typedef int status_t;
  • typedef char bool_t;     
  • typedef char * addr_t;
  • #define TRUE     1
  • #define FALSE    0
  • #define OK       0
  • #define ERROR    -1
  • #define STATIC  static
;