软件设计流程及编写规范

《软件设计流程及编写规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、一、前期方案评估1、主控芯片选型模块化控制要求，整理系统需要的资源。如系统时钟、普通IO拟需要的数目、中断源的个数、AD采样通道的个数、PWM输出的通道数等。在封装等外形尺寸等符合硬件标准的情况下，从上述方面去考虑主控芯片的型号，优先考虑行业通用或是编程人员熟悉的芯片类型。对于无参考的新品项目，在做方案时必须对主控芯片的资源做预留，以备功能扩展或是方案更改需要。如至少留出2个以上的普通IO口，1个以上的AD转换口，1个以上的中断资源。2、主控芯片性能粗测试初期选型通过的主控芯片，DIY一张DEMO实验板，编写测试程序测试所选芯片是否符合工程需要。主要测试单片机

2、的如下性能：1）系统时钟的稳定性2）指令周期3）端口输入输出延迟4）极限工作温度区间5）频漂6）其它专用功能经测试后给出测试结论：Y/N。3、软件方案的制定3.1系统资源分配系统时钟的选择（兼顾系统的运行速度以及实际需求），并非越高越好，如果控制系统要求有精确的定时，优先保证时间精度。如，精确的定时器触发、PWM精确的载波周期等。依据控制对象的具体情况，把控制需求模块化。对不同的功能模块，采用最适合的单片机资源去实现。对每个模块，详细分析模块的功能以及实现方式，对于核心功能，还需给出软件流程图。如要实现AD采样功能，需给出AD的参考电压、转换通道、转换精度等，

3、并且给出采样值的滤波方法。3.2系统结构框架设计设计系统的工作流程，把各功能模块按照一定的逻辑结构组合成完整的系统，其中包括系统框架图，软件流程图，中断管理等。对于中断，必须慎重考虑程序被打断后的恢复问题，如程序在运行到AD采样时被某中断打断，中断函数中依然有AD采样，那么在中端函数执行完后，程序在断点继续执行时AD采样寄存器的值已不再是中断执行前的值。3.3任务进度安排指定软件编写责任人以及进度表。相应文档规整，责任人签字确认后存档。loanapprovalandpostcreditapprovalofficer/atalllevelsinaccordanc

4、ewithcreditapprovalrules,licensingandeventualexerciseofcreditdecisionpowerofpersonsorinstitutions.Reviewfindingsandreviewcomments,accordingtotheBank'scredit二、软件编写规范1、文档文件的结构原则：做到格式清晰、注释简明扼要、命名规范易懂、函数模块化、程序易读易维护、功能准确实现、代码空间效率和时间效率高1.1程序代码和工程空间程序源码和工程空间分别建立各自的文件夹，程序源代码命名时体现出版本序列，工程空间只

5、体现项目名称不含版本号。软件版本升级的时候只需把旧版本的原程序代码文件备份，在工程空间重新加载新版本软件代码。如做一个电机用的控制系统，工程空间(workspace)的建立路径为：“E:MotorControlWorkspace-MotorControl”，源代码存放路径为：“E:MotorControlCode-MotorControl-V1.0”，如版本更新，只需更改源代码的版本，workspace重新加载新的源代码。1.2源代码的组织结构主函数、子函数、中断函数各单独建立一个.c文件，同时每个.c文件都应包含一个同名的.h文件（如果确实不需要，可

6、以没有）。.c文件里面编写功能函数，同名的.h文件里面声明相应的变量以及宏定义。1、标示符的命名标示符命名清晰明了，有明确含义，使用完整单词或是约定俗称的缩写。命名风格要自始至终保持一致，如命名中使用特殊约定或是缩写，要注释说明。2.1宏和常量命名宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。如：#definePWM_CYCLE6402.2变量命名变量名用小写字母命名，每个词的第一个字母大写，注意长度适当，不要定义的过长。变量后缀类型表述变量的大写和数字类型，如果变量是全局变量则还需前缀“G_”。如：un

7、signedcharCurrentValue_8u；signedintPresentSpeed_16s；externunsignedintG_AverageSpeed_16u；2.3函数命名函数名用小写字母命名，每个词的第一个字母大写。如：voidSpeedSampling();3注释有助于对程序的阅读理解，说明程序在"做什么"，解释代码的目的、功能和采用的方法。注释语言必须准确、易懂、简洁，边写代码边注释，修改代码同时修改相应的注释，不再有用的注释要删除。3.1文件头注释loanapprovalandpostcreditapprovalofficer/ata

8、lllevelsinaccordanc