Sofia-SIP辅助文档二 - C语言代码风格指南

 http://sofia-sip.sourceforge.net/refdocs/styleguide.html，翻译自官网的这张网页。

 

这篇文章给出了Sofia-SIP库中关于一般性的C语言风格和编码格式通用指南。指南包括标识符命名规范，约定规范和工具使用指导。请牢记一点，C语言风格只是个人偏好而已。

命名规范

一般情况下，各个模块内的标识符都以本模块名作为前缀。例如，http解析器模块内的函数名都用http_作为前缀。由多个词组成的标识符在词与词之间用下划线“_”连接，所有英文单词都采用小写字母。例如，http_request_create()。

所有的宏都应该采用大写字母。文件名使用小写字母，可能的话用下划线作为分隔符。

通常情况下，typedef类型都有_t后缀，函数类型的后缀是_f。枚举类型名称的后缀是_e，结构类型名称的后缀是_s，以及联合体类型名称的后缀是_u。

建议类型本身都是typedef定义的类型，而不是指向类型的指针。这么做的好处是一眼就能看出一个变量是不是指针。

typedef struct foo_s foo_t;
typedef int fun_f(foo_t *f, char const *s);

结构体和联合体成员应当有着一致的前缀。例如，

struct foo_s {
  int    f_len;
  char  *f_name;
  fun_f *f_fun;
};

前缀的使用使得发现在哪使用成员变量变得非常便利。

缩进和格式化代码

Sofia-SIP中的C代码采用K&R风格的两个字符缩进。单行最大字符数为80个。

例如，

void kluge(int foo)
{
  if (foo) {
    bar();
  }
  else {
    switch (baz()) {
    case a:
      eeny();
      break;
    case b:
      meeny();
      break;
    default:
      moe();
      break;
    }
  }
}

缺省缩进可通过使用带参数的GNU indent获得。（这句啥意思？The default indentation can be achieved with GNU indent with options）

-nbad -bap -bbo -nbc -br -brs -c33 -cd33 -ncdb -ce -ci2 -cli0 -cp33 -cs
-d0 -di1 -nfc1 -nfca -hnl -i2 -ip0 -l79 -lp -npcs -nprs -npsl -saf -sai
-saw -nsc -nsob -nss

无条件循环采用for (;;)而不是while (1)。

  for (;;) {
    foo();
    if (bar())
      break;
    baz();
  }

在中缀操作符的前后都有一个空格，除了.和->这两个操作符前后不能存在空格，以及逗号，它只需要在之后有空格。在关键字和紧跟其后的括号之间应该有一个空格，在标识符和紧跟其后的括号之间不应存在空格，

  while (i++ < n)
    baz();
  for (;;) {
    x->x_foo();
    if (bar())
      break;
    z.z_baz++;
  }
  return (13 * i);