Q_BE02-2019MCU软件设计标准(V1.0).pdf

MCU软件设计标准(V1.0) 一、 总则 为了便于团队合作、实现资源共享、避免无效的重复劳动 （特别是工程师变动之后造成的 重新编写软件的问题），特制定该管理办法，总则如下： 1）对同一系列硬件平台，IDE （集成开发环境）及版本统一、库文件及版本统一、建工程 的方式统一；见附录一 2）软件模块化； 3）代码书写风格统一化； 4）有简要流程图及相关功能说明； IDE、库文件版本、建工程的方式应该由智能控制组统一指定； 二、 软件模块化 1、不同的功能尽量用不同的函数来实现 （特殊情况除外）； 2、功能函数编写时，尽量多考虑通用性，以便在其他项目中可以直接调用；注重可读性， 以便资源共享和维护； 3、时钟、中断、I/O、AD、DA、串口等的初始化分别用单独的函数实现； 三、 代码书写风格 1、在IDE 支持的时候，将不同功能的代码 （哪怕只有一个函数、一条语句）放在不同的 文件中，如图3-1 工程目录。这样有以下好处： 1）方便代码的查找与修改，特别是以后进行代码维护或升级； 2）方便代码在不同项目中的共享； 3）有利于代码移植； 总之，有利于提高工作效率、避免无效的重复劳动。 图3-1 工程目录 2、main()函数单独用一个文件，函数中原则上只进行函数的调用，如图3-2 main()函数 图3-2 main()函数 3、文件名、函数名、变量名、宏定义的命名方式分别统一化。各名称必须用有特定含义 的英文单词或缩写表示 （使用汉语拼音也行）。对全局变量，严禁使用毫无特定含义的字符进 行定义。 建议参考以下方式进行命名 （其中宏定义必须用大写）： 变量的标准定义方式：u32 timer_tick_count = 0; u32 Counter_100us=0; //每100us 增1 u32 Counter_1ms=0; //每1ms 增1 宏定义标准定义方式：#define CMD_MAX_BUFFER 128 函数名的标准定义方式：void USART1_IRQHandler(void) void SysTick_Init_Config(void) 局部变量： u32 i=0,j=0,k=0,x=0,y=0,z=0; u16 m=0,n=0; u8 a=0,b=0,c=0,d=0,e=0,f=0; //如果更多就用 m0、m1、m2，a0、a1、a2 等 4、注释规范化 对每个函数、函数中的关键语句、关键变量必须有简要注释 （中文、英文均可）。行注释 的语句尽量前后对齐，整洁美观；如图3-3/4 注释 图3-3 注释 图3-4 注释 5、排版规范化 程序块要采用缩进风格编写，缩进的空格数为 4 个。代码要紧凑、整齐，方便阅读和修 改。 if、for、do、while 等语句的执行语句部分无论多少都要加括号{ }。如图3-5/6 排版 图3-5 排版 图3-6 排版 6、可读性 注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。 7、为了方便移植和修改，适当多使用宏定义，如图3-7/8 宏定义 图3-7 宏定义 图3-8 宏定义 四、 代码检查表 序号 检查项目 检查结果 1 排版 1.1 程序块要采用缩进风格编写，缩进的空格数为 4 个。