access memo 编码格式_【C编码必备】嵌入式程序员必备编码修养

1、聊一聊

    所谓修养一个"修"一个"养"都是一个长时间的沉淀和总结，同样程序员的编码修养也不例外，一套完善且合理的编码规范和素养也同样是前辈们留下来的宝贵经验，是值得大家学习并遵守的，更重要的是能够帮助大家规避掉许多编码不规范所带来的副作用。     所以今天bug菌分享一篇好文给大家，该文章毕竟不是专业和系统的编码规范等资料，仅仅只是带大家了解一下编程修养所要注意的地方并体验一下一份编程修养对一套优美程序的必要性！     一方面一个合格的公司都会有自己一套完备的编码规范，像bug菌目前就职的公司，一到部门入职前一周都是在学习公司的编码规范，而且还要考试！！     如果你的公司没有这方面的资料也可以参考目前网络广泛流传的规范资料，如《华为C/C++编码规范》、《MISRA C 2012 协议全集》等等，这里bug菌就不给链接了， 独立寻找资料也是一种需要培养的能力 ！加油！     注：bugPS部分仅为bug菌个人观点，大家可以文末留言讨论分享！

2、编码规范是第一步

作者：陈浩      整理 : bug菌     来源：嵌入式云IOT技术圈

    什么是好的程序员？是不是懂得很多技术细节？还是懂底层编程？还是编程速度比较快？我觉得都不是。对于一些技术细节来说和底层的技术，只要看帮助，查资料就能找到，对于速度快，只要编得多也就熟能生巧了。

我认为好的程序员应该有以下几方面的素质：

• 1、有专研精神，勤学善问、举一反三。

• 2、积极向上的态度，有创造性思维。

• 3、与人积极交流沟通的能力，有团队精神。

• 4、谦虚谨慎，戒骄戒燥。

• 5、写出的代码质量高。包括：代码的稳定、易读、规范、易维护、专业。

     这些都是程序员的修养，这里我想谈谈“编程修养”，也就是上述中的第5点。我觉得，如果我要了解一个作者，我会看他所写的小说，如果我要了解一个画家，我会看他所画的图画，如果我要了解一个工人，我会看他所做出来的产品，同样，如果我要了解一个程序员，我想首先我最想看的就是他的程序代码，程序代码可以看出一个程序员的素质和修养，程序就像一个作品，有素质有修养的程序员的作品必然是一图精美的图画，一首美妙的歌曲，一本赏心悦目的小说。

    我看过许多程序，没有注释，没有缩进，胡乱命名的变量名，等等，等等，我把这种人统称为没有修养的程序，这种程序员，是在做创造性的工作吗？不，完全就是在搞破坏，他们与其说是在编程，还不如说是在对源程序进行“加密”，这种程序员，见一个就应该开除一个，因为他编的程序所创造的价值，远远小于需要在上面进行维护的价值。

    程序员应该有程序员的修养，那怕再累，再没时间，也要对自己的程序负责。我宁可要那种动作慢，技术一般，但有良好的写程序风格的程序员，也不要那种技术强、动作快的“搞破坏”的程序员。有句话叫“字如其人”，我想从程序上也能看出一个程序员的优劣。因为，程序是程序员的作品，作品的好坏直截关系到程序员的声誉和素质。而“修养”好的程序员一定能做出好的程序和软件。

    有个成语叫“独具匠心”，意思是做什么都要做得很专业，很用心，如果你要做一个“匠”，也就是造诣高深的人，那么，从一件很简单的作品上就能看出你有没有“匠”的特性，我觉得做一个程序员不难，但要做一个“程序匠”就不简单了。编程序很简单，但编出有质量的程序就难了。

    我在这里不讨论过深的技术，我只想在一些容易让人忽略的东西上说一说，虽然这些东西可能很细微，但如果你不注意这些细微之处的话，那么他将会极大的影响你的整个软件质量，以及整个软件程的实施，所谓“千里之堤，毁于蚁穴”。

   “细微之处见真功”，真正能体现一个程序的功底恰恰在这些细微之处。

    这就是程序员的——编程修养。我总结了在用C/C++语言(主要是C语言)进行程序写作上的三十二个“修养”，通过这些，你可以写出质量高的程序，同时也会让看你程序的人渍渍称道，那些看过你程序的人一定会说：“这个人的编程修养不错”。

3、版权与版本

    好的程序员会给自己的每个函数，每个文件，都注上版权和版本。

    对于C/C++的文件，文件头应该有类似这样的注释：

 1/************************************************************************ 2* 3* 文件名：network.c 4* 5* 文件描述：网络通讯函数集 6* 7* 创建人：Hao Chen, 20XX年2月3日 8* 9* 版本号：V1.010*11* 修改记录：12*13************************************************************************/
14
15而对于函数来说，应该也有类似于这样的注释：
16
17/*================================================================18*19* 函 数 名：XXX20*21* 参 数：22*23* type name [IN] : descripts24*25* 功能描述:26*27* ..............28*29* 返 回 值：成功TRUE，失败FALSE30*31* 抛出异常：32*33* 作 者：ChenHao 20XX/4/234*35================================================================*/

    这样的描述可以让人对一个函数，一个文件有一个总体的认识，对代码的易读性和易维护性有很大的好处。这是好的作品产生的开始。(bugPS:英文注释可能格调更高)

4、缩进、空格、换行、空行、对齐

i)   缩进 应该是每个程序都会做的，只要学程序过程序就应该知道这个，但是我仍然看过不缩进的程序，或是乱缩进的程序，如果你的公司还有写程序不缩进的程序员，请毫不犹豫的开除他吧，并以破坏源码罪起诉他，还要他赔偿读过他程序的人的精神损失费。缩进，这是不成文规矩，我再重提一下吧，一个缩进一般是一个TAB键或是4个空格。(最好用TAB键)

ii)    空格。空格能给程序代来什么损失吗？没有，有效的利用空格可以让你的程序读进来更加赏心悦目。而不一堆表达式挤在一起。看看下面的代码：

1ha=(ha*128+*key++)%tabPtr->size;
2
3ha = ( ha * 128 + *key++ ) % tabPtr->size;

有空格和没有空格的感觉不一样吧。一般来说，语句中要在各个操作符间加空格，函数调用时，要以各个参数间加空格。如下面这种加空格的和不加的：

1if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){
2}
3
4if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){
5}

iii)  换行。不要把语句都写在一行上，这样很不好。如：

1for(i=0;iif((a[i]<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) break;

这种即无空格，又无换行的程序在写什么啊？加上空格和换行吧。

1for ( i=0; i2  if ( ( a[i] '0' || a[i] > '9' ) &&
3     ( a[i] 'a' || a[i] > 'z' ) ) {
4    break;
5  }
6}

好多了吧？有时候，函数参数多的时候，最好也换行，如：

 1CreateProcess(
 2  NULL,
 3  cmdbuf,
 4  NULL,
 5  NULL,
 6  bInhH,
 7  dwCrtFlags,
 8  envbuf,
 9  NULL,
10  &siStartInfo,
11  &prInfo
12);

条件语句也应该在必要时换行：

1if ( ch >= '0' || ch <= '9' ||
2ch >= 'a' || ch <= 'z' ||
3ch >= 'A' || ch <= 'Z' )

iv) 空行。不要不加空行，空行可以区分不同的程序块，程序块间，最好加上空行。如：

 1HANDLE hProcess;
 2PROCESS_T procInfo;
 3
 4/* open the process handle */
 5if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL)
 6{
 7  return LSE_MISC_SYS;
 8}
 9
10memset(&procInfo, 0, sizeof(procInfo));
11procInfo.idProc = pid;
12procInfo.hdProc = hProcess;
13procInfo.misc |= MSCAVA_PROC;
14
15return(0);

v)  对齐。用TAB键对齐你的一些变量的声明或注释，一样会让你的程序好看一些。如：

 1typedef struct _pt_man_t_ {
 2  int numProc;        /* Number of processes */
 3  int maxProc;        /* Max Number of processes */
 4  int numEvnt;        /* Number of events */
 5  int maxEvnt;        /* Max Number of events */
 6  HANDLE* pHndEvnt;   /* Array of events */
 7  DWORD timeout;      /* Time out interval */
 8  HANDLE hPipe;       /* Namedpipe */
 9  TCHAR usr[MAXUSR];  /* User name of the process */
10  int numMsg;         /* Number of Message */
11  int Msg[MAXMSG];    /* Space for intro process communicate */
12} PT_MAN_T;

    怎么样？感觉不错吧。

    这里主要讲述了如果写出让人赏心悦目的代码，好看的代码会让人的心情愉快，读起代码也就不累，工整、整洁的程序代码，通常更让人欢迎，也更让人称道。现在的硬盘空间这么大，不要让你的代码挤在一起，这样它们会抱怨你虐待它们的。好了，用“缩进、空格、换行、空行、对齐”装饰你的代码吧，让他们从没有秩序的土匪中变成一排排整齐有秩序的正规部队吧。(bugPS：对于编码要求比较高的小伙帮经常编辑和编译采用不同的工具进行工作，这样两种环境下的格式处理要尤为注意，因为对于这些空格，tab键的处理或者文字字体等等每个工具或许默认配置有所差别，一般要配置一样后进行编码，防止出现一个工具非常漂亮，而另一个工具打开全乱码)

5、程序注释

    养成写程序注释的习惯，这是每个程序员所必须要做的工作。我看过那种几千行，却居然没有一行注释的程序。这就如同在公路上驾车却没有路标一样。用不了多久，连自己都不知道自己的意图了，还要花上几倍的时间才看明白，这种浪费别人和自己的时间的人，是最为可耻的人。

    是的，你也许会说，你会写注释，真的吗？注释的书写也能看出一个程序员的功底。一般来说你需要至少写这些地方的注释：文件的注释、函数的注释、变量的注释、算法的注释、功能块的程序注释。主要就是记录你这段程序是干什么的？你的意图是什么？你这个变量是用来做什么的？等等。

    不要以为注释好写，有一些算法是很难说或写出来的，只能意会，我承认有这种情况的时候，但你也要写出来，正好可以训练一下自己的表达能力。而表达能力正是那种闷头搞技术的技术人员最缺的，你有再高的技术，如果你表达能力不行，你的技术将不能得到充分的发挥。因为，这是一个团队的时代。

好了，说几个注释的技术细节：

i) 对于行注释(“//”)比块注释(“/* */”)要好的说法，我并不是很同意。因为一些老版本的C编译器并不支持行注释，所以为了你的程序的移植性，请你还是尽量使用块注释。

ii) 你也许会为块注释的不能嵌套而不爽，那么你可以用预编译来完成这个功能。使用“#if 0”和“#endif”括起来的代码，将不被编译，而且还可以嵌套。

(bugPS：对于一些一眼即明的地方能够省略注释尽量省略吧，注释太多也会对阅读代码造成一点的干扰)

6、函数的【in】【out】参数

    我经常看到这样的程序：

 1FuncName(char* str)
 2{
 3  int len = strlen(str);
 4  .....
 5}
 6
 7char*
 8GetUserName(struct user* pUser)
 9{
10  return pUser->name;
11}

    不！请不要这样做。

    你应该先判断一下传进来的那个指针是不是为空。如果传进来的指针为空的话，那么，你的一个大的系统就会因为这一个小的函数而崩溃。一种更好的技术是使用断言(assert)，这里我就不多说这些技术细节了。当然，如果是在C++中，引用要比指针好得多，但你也需要对各个参数进行检查。

    写有参数的函数时，首要工作，就是要对传进来的所有参数进行合法性检查。而对于传出的参数也应该进行检查，这个动作当然应该在函数的外部，也就是说，调用完一个函数后，应该对其传出的值进行检查。

    当然，检查会浪费一点时间，但为了整个系统不至于出现“非法操作”或是“Core Dump”的系统级的错误，多花这点时间还是很值得的。

7、对系统调用的返回进行判断

    继续上一条，对于一些系统调用，比如打开文件，我经常看到，许多程序员对fopen返回的指针不做任何判断，就直接使用了。然后发现文件的内容怎么也读出不，或是怎么也写不进去。还是判断一下吧：

1fp = fopen("log.txt", "a");
2if ( fp == NULL ){
3  printf("Error: open file error\n");
4  return FALSE;
5}

    其它还有许多啦，比如：socket返回的socket号，malloc返回的内存。请对这些系统调用返回的东西进行判断。(bugPS:对于函数的返回其实也是如此)

8、if语句对错误的处理

    我看见你说了，这有什么好说的。还是先看一段程序代码吧。

1if ( ch >= '0' && ch <= '9' ){
2  /* 正常处理代码 */
3}else{
4  /* 输出错误信息 */
5  printf("error ......\n");
6  return ( FALSE );
7}

    这种结构很不好，特别是如果“正常处理代码”很长时，对于这种情况，最好不要用else。先判断错误，如：

1if ( ch '0' || ch > '9' ){
2  /* 输出错误信息 */
3  printf("error ......\n");
4  return ( FALSE );
5}
6/* 正常处理代码 */
7......

    这样的结构，不是很清楚吗？突出了错误的条件，让别人在使用你的函数的时候，第一眼就能看到不合法的条件，于是就会更下意识的避免。

9、头文件中的#ifndef

    千万不要忽略了头件的中的#ifndef，这是一个很关键的东西。比如你有两个C文件，这两个C文件都include了同一个头文件。而编译时，这两个C文件要一同编译成一个可运行文件，于是问题来了，大量的声明冲突。

    还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用，你都要加上这个。一般格式是这样的：

1#ifndef 
2#define 
3
4......
5......
6
7#endif

    在理论上来说可以是自由命名的，但每个头文件的这个“标识”都应该是唯一的。标识的命名规则一般是头文件名全大写，前后加下划线，并把文件名中的“.”也变成下划线，如：stdio.h

1#ifndef _STDIO_H_
2#define _STDIO_H_
3
4......
5
6#endif

(BTW：预编译有多很有用的功能。你会用预编译吗？)

10、变量的初始化

    接上一条，变量一定要被初始化再使用。C/C++编译器在这个方面不会像JAVA一样帮你初始化，这一切都需要你自己来，如果你使用了没有初始化的变量，结果未知。好的程序员从来都会在使用变量前初始化变量的。如：

1. 对malloc分配的内存进行memset清零操作。(可以使用calloc分配一块全零的内存)
2. 对一些栈上分配的struct或数组进行初始化。(最好也是清零)

    不过话又说回来了，初始化也会造成系统运行时间有一定的开销，所以，也不要对所有的变量做初始化，这个也没有意义。好的程序员知道哪些变量需要初始化，哪些则不需要。如：以下这种情况，则不需要。

1char *pstr; /* 一个字符串 */
2pstr = ( char* ) malloc( 50 );
3if ( pstr == NULL ) exit(0);
4strcpy( pstr, "Hello Wrold" );

    但如果是下面一种情况，最好进行内存初始化。(bugPS:指针不初始化还是比较危险的，记得使用前都要初始化)

1char **pstr; /* 一个字符串数组 */
2pstr = ( char** ) malloc( 50 );
3if ( pstr == NULL ) exit(0);
4
5/* 让数组中的指针都指向NULL */
6memset( pstr, 0, 50*sizeof(char*) );

    而对于全局变量，和静态变量，一定要声明时就初始化。因为你不知道它第一次会在哪里被使用。所以使用前初始这些变量是比较不现实的，一定要在声明时就初始化它们。如：

1Links *plnk = NULL; /* 对于全局变量plnk初始化为NULL */

11、.h和.c文件的使用

    H文件和C文件怎么用呢？一般来说，H文件中是declare(声明)，C文件中是define(定义)。因为C文件要编译成库文件(Windows下是.obj/.lib，UNIX下是.o/.a)，如果别人要使用你的函数，那么就要引用你的H文件，所以，H文件中一般是变量、宏定义、枚举、结构和函数接口的声明，就像一个接口说明文件一样。而C文件则是实现细节。

    H文件和C文件最大的用处就是声明和实现分开。这个特性应该是公认的了，但我仍然看到有些人喜欢把函数写在H文件中，这种习惯很不好。(如果是C++话，对于其模板函数，在VC中只有把实现和声明都写在一个文件中，因为VC不支持export关键字)。而且，如果在H文件中写上函数的实现，你还得在makefile中把头文件的依赖关系也加上去，这个就会让你的makefile很不规范。

   最后，有一个最需要注意的地方就是：带初始化的全局变量不要放在H文件中！

(bugPS:可以参考:C语言为什么一般不在.h中定义函数或者变量?(精华))

    例如有一个处理错误信息的结构：

 1char* errmsg[] = {
 2  /* 0 */ "No error",
 3  /* 1 */ "Open file error",
 4  /* 2 */ "Failed in sending/receiving a message",
 5  /* 3 */ "Bad arguments",
 6  /* 4 */ "Memeroy is not enough",
 7  /* 5 */ "Service is down; try later",
 8  /* 6 */ "Unknow information",
 9  /* 7 */ "A socket operation has failed",
10  /* 8 */ "Permission denied",
11  /* 9 */ "Bad configuration file format",
12  /* 10 */ "Communication time out",
13  ......
14  ......
15};

    请不要把这个东西放在头文件中，因为如果你的这个头文件被5个函数库(.lib或是.a)所用到，于是他就被链接在这5个.lib或.a中，而如果你的一个程序用到了这5个函数库中的函数，并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执行文件中。如果你的这个errmsg很大的话，而且你用到的函数库更多的话，你的执行文件也会变得很大。

    正确的写法应该把它写到C文件中，然后在各个需要用到errmsg的C文件头上加上 extern char* errmsg[]; 的外部声明，让编译器在链接时才去管他，这样一来，就只会有一个errmsg存在于执行文件中，而且，这样做很利于封装。

    我曾遇到过的最疯狂的事，就是在我的目标文件中，这个errmsg一共有112个副本，执行文件有8M左右。当我把errmsg放到C文件中，并为一千多个C文件加上了extern的声明后，所有的函数库文件尺寸都下降了20%左右，而我的执行文件只有5M了。一下子少了3M啊。

备注

     有朋友对我说，这个只是一个特例，因为，如果errmsg在执行文件中存在多个副本时，可以加快程序运行速度，理由是errmsg的多个复本会让系统的内存换页降低，达到效率提升。像我们这里所说的errmsg只有一份，当某函数要用errmsg时，如果内存隔得比较远，会产生换页，反而效率不高。

     这个说法不无道理，但是一般而言，对于一个比较大的系统，errmsg是比较大的，所以产生副本导致执行文件尺寸变大，不仅增加了系统装载时间，也会让一个程序在内存中占更多的页面。而对于errmsg这样数据，一般来说，在系统运行时不会经常用到，所以还是产生的内存换页也就不算频繁。权衡之下，还是只有一份errmsg的效率高。即便是像logmsg这样频繁使用的的数据，操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存，所以也就不会出现内存换页问题了。

12、出错信息的处理

    你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：

1if ( p == NULL ){
2  printf ( "ERR: The pointer is NULL\n" );
3}

    告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该统一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部分说明。如果要管理错误信息，那就要有以下的处理：

 1/* 声明出错代码 */
 2#define ERR_NO_ERROR 0 /* No error */
 3#define ERR_OPEN_FILE 1 /* Open file error */
 4#define ERR_SEND_MESG 2 /* sending a message error */
 5#define ERR_BAD_ARGS 3 /* Bad arguments */
 6#define ERR_MEM_NONE 4 /* Memeroy is not enough */
 7#define ERR_SERV_DOWN 5 /* Service down try later */
 8#define ERR_UNKNOW_INFO 6 /* Unknow information */
 9#define ERR_SOCKET_ERR 7 /* Socket operation failed */
10#define ERR_PERMISSION 8 /* Permission denied */
11#define ERR_BAD_FORMAT 9 /* Bad configuration file */
12#define ERR_TIME_OUT 10 /* Communication time out */
13
14/* 声明出错信息 */
15char* errmsg[] = {
16/* 0 */ "No error",
17/* 1 */ "Open file error",
18/* 2 */ "Failed in sending/receiving a message",
19/* 3 */ "Bad arguments",
20/* 4 */ "Memeroy is not enough",
21/* 5 */ "Service is down; try later",
22/* 6 */ "Unknow information",
23/* 7 */ "A socket operation has failed",
24/* 8 */ "Permission denied",
25/* 9 */ "Bad configuration file format",
26/* 10 */ "Communication time out",
27};
28
29/* 声明错误代码全局变量 */
30long errno = 0;
31
32/* 打印出错信息函数 */
33void perror( char* info)
34{
35  if ( info ){
36    printf("%s: %s\n", info, errmsg[errno] );
37    return;
38  }
39  printf("Error: %s\n", errmsg[errno] );
40}

    这个基本上是ANSI的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理：

 1bool CheckPermission( char* userName )
 2{
 3  if ( strcpy(userName, "root") != 0 ){
 4  errno = ERR_PERMISSION_DENIED;
 5  return (FALSE);
 6}
 7
 8...
 9}
10
11main()
12{
13  ...
14  if (! CheckPermission( username ) ){
15  perror("main()");
16}
17...
18}

    一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用户界面，而不会因为文件打开失败，A程序员出一个信息，B程序员又出一个信息。而且这样做，非常容易维护。代码也易读。

    当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息或是提示信息是其关键，但即使这样，这也包括了大多数的信息。

13、常用函数和循环语句中的被计算量

    看一下下面这个例子：

1for( i=0; i<1000; i++ ){
2  GetLocalHostName( hostname );
3  ...
4}

    GetLocalHostName的意思是取得当前计算机名，在循环体中，它会被调用1000次啊。这是多么的没有效率的事啊。应该把这个函数拿到循环体外，这样只调用一次，效率得到了很大的提高。虽然，我们的编译器会进行优化，会把循环体内的不变的东西拿到循环外面，但是，你相信所有编译器会知道哪些是不变的吗？我觉得编译器不可靠。最好还是自己动手吧。

同样，对于常用函数中的不变量，如：

1GetLocalHostName(char* name)
2{
3  char funcName[] = "GetLocalHostName";
4
5  sys_log( "%s begin......", funcName );
6  ...
7  sys_log( "%s end......", funcName );
8}

    如果这是一个经常调用的函数，每次调用时都要对funcName进行分配内存，这个开销很大啊。把这个变量声明成static吧，当函数再次被调用时，就会省去了分配内存的开销，执行效率也很好。

14、函数名和变量名的命令

   我看到许多程序对变量名和函数名的取名很草率，特别是变量名，什么a,b,c,aa,bb,cc，还有什么flag1,flag2, cnt1, cnt2，这同样是一种没有“修养”的行为。即便加上好的注释。好的变量名或是函数名，我认为应该有以下的规则：

1. 直观并且可以拼读，可望文知意，不必“解码”。
2. 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。
3. 不要全部大写，也不要全部小写，应该大小写都有，如：GetLocalHostName 或是 UserAccount。
4. 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode, ServerListener -> ServLisner，UserAccount -> UsrAcct 等。
5. 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前缀。
6. 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。
7. 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。
8. 与标准库(如：STL)或开发库(如：MFC)的命名风格保持一致。