个人代码规范

1.文件注释

1)要求
至少要包含文件名称、文件作用说明、编码人、版本号、最后修改时间。

2)举例
源文件
/******************************************************************************                                
* 名    称:        move_power.c                   
* 功    能:        移动电源的通信协议           
* 作    者:        neha
* 版 本 号:       v1.0                                              
* 修改时间:        2018.4.16           
******************************************************************************/  

头文件
/******************************************************************************                                
* 名    称:        move_power.h                   
* 功    能:        移动电源的通信协议的头文件            
* 作    者:        neha      
* 版 本 号:       v1.0                                                  
* 修改时间:        2018.4.16           
******************************************************************************/    

2.类型的宏替换

1)要求
要求用“#ifndef”判断是否之前被定义过。

2)举例
#ifndef uint8       
typedef unsigned char uint8;       
#endif               

3.宏定义

1)要求
宏全为大写的英文字母。
宏的名称应能读出其功能作用。

2)举例
#define MOVE_POWER_FALSE     0    
#define MOVE_POWER_TRUE      1  

4.函数注释

1)要求
至少要包含函数名称、函数作用说明、形参含义、返回值含义。

2)举例
/****************************************************************************
* 函 数 名: move_external_current()
* 功    能: 获取充电器输入的电流值
* 入口参数: *current 指向电流值的指针
* 出口参数: SUCCESS or FAILUR 正确或错误
****************************************************************************/  
static uint8 move_external_current( uint32 *current )
{
    uint8 stat = SUCCESS;

    *current = move_charge.vbus_current;

    return stat;
}




阅读更多
想对作者说点什么?

博主推荐

换一批

没有更多推荐了,返回首页