[信息与通信]DSP C语言编程规范.doc

DSP C语言编程规范 版本 时间 作者 Version 1.0 2010.02.24 刘 昊 编写目的：此规范主要用于规范基于DSP的代码开发，可以有效提高代码的可读性、可移植性、可靠性等，提高DSP的开发效率，其它C或C++也可以参考此规范，此规范对C或C++编程有普遍指导性。 其中第1~9为基础篇，第10~14为提高篇。 1. 目录结构 3 2. 各文件的功能划分 3 3. 排版 5 4. 注释 11 5. 标识符命名 15 6. 宏 18 7. 可读性 19 8. 变量、结构 21 9. 函数、过程 26 10. 可测性 33 11. 程序效率 38 12. 质量保证 42 13. 代码编辑、编译、审查 49 14. 代码测试、维护 51  目录结构 如下图所示，一个工程的根目录应该新建三个文件夹：src、include、lib，src文件夹用来存放*.c文件（C语言）、*.cpp文件（C++语言）、*.asm文件（汇编）；include文件夹用来存放*.h文件、*.inc文件、*.dat文件；lib文件夹用来存放*.lib及其相关的文件。与工程相关的文件放在工程的根目录下，如.pjt（工程文件）、.cmd、.cdb等。 各文件的功能划分 src文件夹里的*.c文件（C语言）、*.cpp文件（C++语言）、*.asm文件（汇编）用来做每个函数的具体实现，一个完整功能实现相关的函数放在一个文件中实现。 每个*.c文件（C语言）、*.cpp文件（C++语言）都要有一个同名的*.h文件，在这个.h文件中写每个函数的声明，例如foo.c文件应该有一个foo.h文件包含foo.c中每个函数的声明，且每个头文件都应该用内部保护符保护每个头文件，以避免在多次包含时重新定义： 例如，头文件foo.h应该采用下面的一般形式：#ifndef _FOO_H #define _FOO_H // ……文件内容……#include “ MACRO.h ” #include “ TYPE.h ” #include “ ***.h ” … extern int funa(int a, int b,int c); … #endif 其中，有几个特殊的头文件用来做一些整个工程的宏定义或是类型定义，如XXX_DSP_MACRO.h用来定义整个工程所有的宏定义，XXX_DSP_TYPE.h用来定义整个工程所有的类型定义。 *.inc文件用来定义全局变量，XXX_DSP_GBL_L2.inc文件用来定义分配在DSP的L2里全局变量，XXX_DSP_GBL_SDRAM.inc文件用来定义分配在DSP的SDRAM里全局变量，其具体写如例： #include XXX_DSP_ MACRO.h #include XXX_DSP_TYPE.h #ifdef _GBL_EX #define GBL_extern #else #define GBL_extern extern #endif /* FFT旋转因子 */ #ifdef _GBL_EX #pragma DATA_ALIGN(gacsfftFactor, 16) #endif GBL_extern const INT32 gacsfftFactor[128] #ifdef _GBL_EX ={ #include FFT128.dat } #endif ; 排版 3.1：程序块要采用缩进风格编写，缩进的空格数为4个，对齐只能使用空格键，不使用TAB键。 说明：对于由开发工具自动生成的代码可以有不一致。（不做强制要求） 3.2：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 应如下书写 ： if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni; 3.3：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行， 操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof(