C语言代码规范——AliOS Things

1 前言

2 命名

2.1 总则

2.2 文件命名

2.3 类型命名

typedef int32_t aos_status_t;

typedef struct aos_list_node {    struct aos_list_node *prev;    struct aos_list_node *next;} aos_list_node_t;
static aos_list_node_t list_node;

typedef enum aos_socket_stage {    AOS_SOCK_STG_DISCONNECTED,    AOS_SOCK_STG_CONNECTED,} aos_socket_stage_t;
static aos_socket_stage_t sock_stage = AOS_SOCK_STG_DISCONNECTED;

2.4 变量命名

cfg_file_t cfg_files[NUM_CFG_FILES];

unsigned int num_files;

unsigned int file_num;unsigned int file_index;

2.5 函数命名

2.6 宏命名

#define AOS_STRING_MAX_LEN 127

#define aos_dev_set_id(dev, x) \    do { \        (dev)->id = (x); \    } while (0)

2.7 前缀

void aos_cfg_file_close(int fd);extern char **aos_process_argv;typedef struct aos_list_node aos_list_node_t;#define AOS_STRING_MAX_LEN 127

3 格式

3.1 文本格式

3.2 行长度

void foo(void){    if ((aos_list_next(list_node) != &list_head && !priv) ||        !(strcmp(symbol, default_symbol) && blahblahblahblahblahblah() &&          meomeomeomeomeomeomeomeomeomeomeomeomeomeomeomeo(NULL))) {        /* ... */    }}

static unsigned longblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblah(void);static const manager_priv_t*blahblahblahblahblahblahblahblahblahblahblahblahblahblahblahblah(int index);

void blahblahblahblahblahblahblahblahblah(manager_priv_t *priv, int index,                                          const char *proc_name);
void foo(void){    blahblahblahblahblahblahblahblahblahblah(get_manager_priv(manager), 0,                                             "meomeomeomeomeomeomeomeo");}

void foo(void){    printf("The GNU operating system consists of GNU packages "           "(programs specifically released by the GNU Project) "           "as well as free software released by third parties.\n");}

3.3 缩进

void foo(unsigned int nbr_processes){    unsigned int i;
    while (i < nbr_processes) {        const char *name;        /* ... */    }}

/* 此处数字0缩进32个字符，即位于第33列。 */#define STAGE_UPDATE_CONTINUE   0#define STAGE_UPDATE_COMPLETE   1
/* 合法 */#define EVENT_RX_FULL (1U << 0)#define EVENT_TX_EMPTY (1U << 1)
typdef enum socket_stage {    /* 此处等号缩进32个字符，即位于第33列。 */    SOCK_STG_DISCONNECTED       = 0,    SOCK_STG_CONNECTED          = 1,} socket_stage_t;
/* 此处反斜杠缩进40个字符，即位于第41列。 */#define aos_dev_set_flags(dev, x)       \    do {                                \        (dev)->flags = (x);             \    } while (0)
/* 合法 */#define aos_dev_set_ops(dev, x) \    do { \        (dev)->ops = (x); \    } while (0)
/* 此处注释缩进24个字符，即位于第25列。 */foo(NULL);              /* abc */blahblahblahblahblah(); /* xyz */
/* 合法 */foofoofoo(); /* abc */foofoo(); /* xyz */

#define aos_dev_set_id(dev, x) \    do { \        (dev)->id = (x); \    } while (0)switch块中的case语句和default语句与switch语句缩进层级相同。例如：switch (stage) {case SOCK_STG_DISCONNECTED:    foo();    break;case SOCK_STG_CONNECTED:    sock->connected = 1;    break;default:    break;}

3.4 花括号

typedef struct manager_priv {    int index;    void *data;} manager_priv_t;
#define set_manager_index(x, idx) do { (x)->priv->index = (idx); } while (0)
#ifdef __cplusplusextern "C" {#endif
void foo(void){    int i = 0;
    /* ... */
    if (i == 0) {        /* ... */    } else {        /* ... */    }}
manager_priv_t priv = { 0, NULL, };
#ifdef __cplusplus}#endif

3.5 空格

x = a ? b : c;v = w * x + y / z;len = x.length;priv = proc->priv;

x = *p;p = &x;i++;j = --i;

void foo(int x, int y);

for (i = 0; i < strlen(str);) {    for (;;) {        /* ... */    }}

len = strlen(name);
for (i = 0; i < count; i++) {    /* ... */}

while (1) {    /* ... */}
if (i == 0) {    /* ... */}

int load_file(const char *name){    foo(0);    /* ... */}

manager_priv_t *priv = (manager_priv_t *)p;

c = name[i];

#define set_manager_index(x, idx) do { (x)->priv->index = (idx); } while (0)
manager_priv_t priv = { 0, NULL, };

#define set_manager_index(x, idx) \    do { \        (x)->priv->index = (idx); \    } while (0)

3.6 指针

int *p;const char *name;void * const ptr;void (*func)(void *arg);

3.7 数值常量

unsigned int b = 0b0101;unsigned int x = 0xABCDEF;unsigned int u = 0U;long int l = 0L;unsigned long int ul = 0UL;float f = 1.0f;long double ld = 1.0L;double dd = -1.5e-5;double xd = 0xA.Bp12;

3.8 注释

/* * This source file is part of AliOS Things. * Zhang San <zhangsan@example.com> * 2021.07.01 */
/* Zhang San <zhangsan@example.com> * 2021.07.01 */
/* This pointer must NOT be NULL. */
/* connecting */

4 头文件

4.1 路径

#include <aos/file.h>

4.2 引号和尖括号

#include <stdio.h>#include "my_demo.h"

4.3 包含次序

#include <stdio.h>#include <pthread.h>#include <openssl/rsa.h>#include <aos/headers.h>#include "my_demo.h"

4.4 保护

#ifndef AOS_COMMON_H#define AOS_COMMON_H
/* 全部内容 */
#endif /* AOS_COMMON_H */

4.5 函数、变量声明

void aos_cfg_file_close(int fd);extern char **aos_process_argv;

4.6 extern "C"关键字

#ifndef AOS_COMMON_H#define AOS_COMMON_H
#include <stddef.h>
#define AOS_STRING_MAX_LEN      127#define AOS_LSTRING_MAX_LEN     511
typedef struct aos_tm {    unsigned int sec;    unsigned int min;    unsigned int hour;    unsigned int mday;    unsigned int mon;    unsigned int year;} aos_tm_t;
#ifdef __cplusplusextern "C" {#endif
extern char aos_process_symbol[AOS_STRING_MAX_LEN + 1];
void aos_start(void);
#ifdef __cplusplus}#endif
#endif /* AOS_COMMON_H */

5 其他注意事项

int offsets[] = {    0,    1,};